From d60c35b58257b9691a38d035b627fca5fe52b47d Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Wed, 15 Oct 2025 15:11:59 +0000 Subject: [PATCH 01/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- auto-generated-sdk/.openapi-generator/FILES | 172 +- auto-generated-sdk/README.md | 125 +- auto-generated-sdk/api/openapi.yaml | 30080 ++++------------ auto-generated-sdk/build.gradle | 2 +- auto-generated-sdk/build.sbt | 2 +- auto-generated-sdk/docs/AccountDirectories.md | 1 + auto-generated-sdk/docs/CalculationStatus.md | 1 + .../docs/CalculationStatusMeta.md | 3 +- .../docs/CalculationUnitStatus.md | 1 + .../docs/CalculationUnitStatusMeta.md | 1 + auto-generated-sdk/docs/Column.md | 20 - auto-generated-sdk/docs/ColumnRoot.md | 18 - auto-generated-sdk/docs/ColumnStatistic.md | 17 - .../docs/ColumnStatisticRoot.md | 18 - auto-generated-sdk/docs/ColumnSummary.md | 20 - auto-generated-sdk/docs/ColumnsApi.md | 179 - auto-generated-sdk/docs/ComponentsApi.md | 172 +- auto-generated-sdk/docs/ConfigurationsApi.md | 4 +- auto-generated-sdk/docs/Currency.md | 1 + auto-generated-sdk/docs/DatesApi.md | 90 - auto-generated-sdk/docs/DocumentsApi.md | 84 - .../docs/FIConvertibleSettings.md | 32 + auto-generated-sdk/docs/FISecurity.md | 1 + auto-generated-sdk/docs/FPOAccount.md | 19 - auto-generated-sdk/docs/FPOObjective.md | 27 - .../docs/FPOOptimizationParameters.md | 20 - .../docs/FPOOptimizationParametersRoot.md | 18 - .../docs/FPOOptimizerStrategy.md | 18 - .../docs/FPOOptimizerStrategyOverrides.md | 29 - auto-generated-sdk/docs/FiCalculationsApi.md | 2 +- auto-generated-sdk/docs/FpoOptimizerApi.md | 527 - auto-generated-sdk/docs/FrequenciesApi.md | 78 - auto-generated-sdk/docs/Group.md | 19 - auto-generated-sdk/docs/GroupRoot.md | 18 - auto-generated-sdk/docs/GroupsApi.md | 165 - auto-generated-sdk/docs/LinkedPATemplate.md | 23 - .../docs/LinkedPATemplateParameters.md | 20 - .../docs/LinkedPATemplateParametersRoot.md | 18 - .../docs/LinkedPATemplatePostSummary.md | 20 - .../docs/LinkedPATemplatePostSummaryRoot.md | 18 - .../docs/LinkedPATemplateRoot.md | 18 - .../docs/LinkedPATemplateSummary.md | 19 - .../docs/LinkedPATemplateSummaryRoot.md | 18 - .../docs/LinkedPATemplateUpdateParameters.md | 19 - .../LinkedPATemplateUpdateParametersRoot.md | 18 - .../docs/LinkedPaTemplatesApi.md | 460 - .../docs/PACalculationColumn.md | 18 - .../docs/PACalculationDataSources.md | 19 - auto-generated-sdk/docs/PACalculationGroup.md | 18 - .../docs/PACalculationParameters.md | 25 - .../docs/PACalculationParametersRoot.md | 18 - .../docs/PACalculationPricingSource.md | 17 - auto-generated-sdk/docs/PAComponent.md | 25 - auto-generated-sdk/docs/PAComponentData.md | 24 - auto-generated-sdk/docs/PAComponentRoot.md | 18 - auto-generated-sdk/docs/PADateParameters.md | 20 - auto-generated-sdk/docs/PAIdentifier.md | 18 - auto-generated-sdk/docs/PAPricingSource.md | 19 - .../docs/PAPricingSourceRoot.md | 18 - auto-generated-sdk/docs/PaCalculationsApi.md | 645 - auto-generated-sdk/docs/PaDoc.md | 17 - auto-generated-sdk/docs/PricingSourcesApi.md | 97 - auto-generated-sdk/docs/PubCalculationsApi.md | 24 +- .../docs/QuantCalculationsApi.md | 2 +- .../docs/QuantDateListObsolete.md | 20 - .../docs/QuantFdsDateObsolete.md | 21 - .../docs/QuantFqlExpressionObsolete.md | 20 - .../docs/QuantIdentifierUniverseObsolete.md | 38 - .../docs/QuantScreeningExpressionObsolete.md | 19 - ...uantScreeningExpressionUniverseObsolete.md | 39 - .../QuantUniversalScreenParameterObsolete.md | 18 - .../QuantUniversalScreenUniverseObsolete.md | 28 - auto-generated-sdk/docs/SPARDateParameters.md | 1 + .../docs/SparCalculationsApi.md | 2 +- .../docs/StrategyDocumentsApi.md | 84 - .../docs/TemplateContentTypes.md | 19 - .../docs/TemplatedPAComponent.md | 24 - .../docs/TemplatedPAComponentParameters.md | 20 - .../TemplatedPAComponentParametersRoot.md | 18 - .../docs/TemplatedPAComponentPostSummary.md | 21 - .../TemplatedPAComponentPostSummaryRoot.md | 18 - .../docs/TemplatedPAComponentRoot.md | 18 - .../docs/TemplatedPAComponentSummary.md | 20 - .../docs/TemplatedPAComponentSummaryRoot.md | 18 - .../TemplatedPAComponentUpdateParameters.md | 19 - ...emplatedPAComponentUpdateParametersRoot.md | 18 - .../docs/TemplatedPaComponentsApi.md | 467 - auto-generated-sdk/docs/UnlinkedPATemplate.md | 32 - .../docs/UnlinkedPATemplateCategoryAndType.md | 18 - ...nlinkedPATemplateCategoryAndTypeDetails.md | 22 - ...kedPATemplateCategoryAndTypeDetailsRoot.md | 18 - .../UnlinkedPATemplateCategoryAndTypeRoot.md | 18 - .../docs/UnlinkedPATemplateColumnDetails.md | 19 - .../docs/UnlinkedPATemplateGroupDetails.md | 19 - .../docs/UnlinkedPATemplateParameters.md | 28 - .../docs/UnlinkedPATemplateParametersRoot.md | 18 - .../docs/UnlinkedPATemplatePostSummary.md | 20 - .../docs/UnlinkedPATemplatePostSummaryRoot.md | 18 - .../docs/UnlinkedPATemplateRoot.md | 18 - .../docs/UnlinkedPATemplateSummary.md | 19 - .../docs/UnlinkedPATemplateSummaryRoot.md | 18 - .../UnlinkedPATemplateUpdateParameters.md | 26 - .../UnlinkedPATemplateUpdateParametersRoot.md | 18 - .../docs/UnlinkedPaTemplatesApi.md | 648 - ...icsApi.md => VaultAttributionLoaderApi.md} | 38 +- .../docs/VaultAttributionLoaderResponse.md | 19 + ... => VaultAttributionLoaderResponseRoot.md} | 4 +- .../docs/VaultCalculationsApi.md | 2 +- auto-generated-sdk/pom.xml | 4 +- .../analyticsapi/engines/ApiClient.java | 2 +- .../analyticsapi/engines/api/ColumnsApi.java | 223 - .../engines/api/ComponentsApi.java | 179 - .../analyticsapi/engines/api/DatesApi.java | 108 - .../engines/api/DocumentsApi.java | 89 - .../engines/api/FiCalculationsApi.java | 2 +- .../engines/api/FpoOptimizerApi.java | 592 - .../engines/api/FrequenciesApi.java | 75 - .../analyticsapi/engines/api/GroupsApi.java | 199 - .../engines/api/LinkedPaTemplatesApi.java | 500 - .../engines/api/PaCalculationsApi.java | 688 - .../engines/api/PricingSourcesApi.java | 139 - .../engines/api/PubCalculationsApi.java | 44 +- .../engines/api/QuantCalculationsApi.java | 2 +- .../engines/api/SparCalculationsApi.java | 2 +- .../engines/api/StrategyDocumentsApi.java | 89 - .../engines/api/TemplatedPaComponentsApi.java | 496 - .../engines/api/UnlinkedPaTemplatesApi.java | 658 - ...pi.java => VaultAttributionLoaderApi.java} | 63 +- .../engines/api/VaultCalculationsApi.java | 2 +- .../engines/models/AccountDirectories.java | 3 +- .../engines/models/CalculationStatus.java | 3 +- .../engines/models/CalculationStatusMeta.java | 7 +- .../engines/models/CalculationUnitStatus.java | 3 +- .../models/CalculationUnitStatusMeta.java | 3 +- .../analyticsapi/engines/models/Column.java | 209 - .../engines/models/ColumnRoot.java | 141 - .../engines/models/ColumnStatistic.java | 111 - .../engines/models/ColumnStatisticRoot.java | 146 - .../engines/models/ColumnSummary.java | 172 - .../engines/models/ColumnSummaryRoot.java | 146 - .../analyticsapi/engines/models/Currency.java | 3 +- .../engines/models/FIConvertibleSettings.java | 298 + .../engines/models/FISecurity.java | 33 +- .../engines/models/FPOAccount.java | 172 - .../engines/models/FPOObjective.java | 184 - .../models/FPOOptimizationParameters.java | 203 - .../models/FPOOptimizationParametersRoot.java | 142 - .../engines/models/FPOOptimizerStrategy.java | 141 - .../models/FPOOptimizerStrategyOverrides.java | 245 - .../analyticsapi/engines/models/Group.java | 171 - .../engines/models/GroupRoot.java | 146 - .../engines/models/LinkedPATemplate.java | 292 - .../models/LinkedPATemplateParameters.java | 200 - .../LinkedPATemplateParametersRoot.java | 141 - .../models/LinkedPATemplatePostSummary.java | 201 - .../LinkedPATemplatePostSummaryRoot.java | 141 - .../engines/models/LinkedPATemplateRoot.java | 141 - .../models/LinkedPATemplateSummary.java | 171 - .../models/LinkedPATemplateSummaryRoot.java | 146 - .../LinkedPATemplateUpdateParameters.java | 172 - .../LinkedPATemplateUpdateParametersRoot.java | 141 - .../engines/models/PACalculationColumn.java | 149 - .../models/PACalculationDataSources.java | 188 - .../engines/models/PACalculationGroup.java | 141 - .../models/PACalculationParameters.java | 387 - .../models/PACalculationParametersRoot.java | 151 - .../models/PACalculationPricingSource.java | 111 - .../engines/models/PAComponent.java | 369 - .../engines/models/PAComponentData.java | 358 - .../engines/models/PAComponentRoot.java | 141 - .../engines/models/PADateParameters.java | 170 - .../engines/models/PAIdentifier.java | 140 - .../engines/models/PAPricingSource.java | 171 - .../engines/models/PAPricingSourceRoot.java | 146 - .../analyticsapi/engines/models/PaDoc.java | 110 - .../engines/models/QuantDateListObsolete.java | 207 - .../engines/models/QuantFdsDateObsolete.java | 227 - .../models/QuantFqlExpressionObsolete.java | 199 - .../QuantIdentifierUniverseObsolete.java | 246 - .../QuantScreeningExpressionObsolete.java | 169 - ...ntScreeningExpressionUniverseObsolete.java | 271 - ...QuantUniversalScreenParameterObsolete.java | 139 - .../QuantUniversalScreenUniverseObsolete.java | 177 - .../engines/models/SPARDateParameters.java | 36 +- .../engines/models/TemplateContentTypes.java | 195 - .../engines/models/TemplatedPAComponent.java | 322 - .../TemplatedPAComponentParameters.java | 200 - .../TemplatedPAComponentPostSummary.java | 231 - .../TemplatedPAComponentPostSummaryRoot.java | 141 - .../models/TemplatedPAComponentRoot.java | 141 - .../models/TemplatedPAComponentSummary.java | 201 - .../TemplatedPAComponentSummaryRoot.java | 146 - .../TemplatedPAComponentUpdateParameters.java | 172 - ...platedPAComponentUpdateParametersRoot.java | 141 - .../engines/models/UnlinkedPATemplate.java | 599 - .../UnlinkedPATemplateCategoryAndType.java | 141 - ...inkedPATemplateCategoryAndTypeDetails.java | 279 - ...dPATemplateCategoryAndTypeDetailsRoot.java | 141 - ...UnlinkedPATemplateCategoryAndTypeRoot.java | 146 - .../UnlinkedPATemplateColumnDetails.java | 179 - .../UnlinkedPATemplateGroupDetails.java | 171 - .../models/UnlinkedPATemplateParameters.java | 477 - .../UnlinkedPATemplateParametersRoot.java | 141 - .../models/UnlinkedPATemplatePostSummary.java | 201 - .../UnlinkedPATemplatePostSummaryRoot.java | 141 - .../models/UnlinkedPATemplateRoot.java | 141 - .../models/UnlinkedPATemplateSummary.java | 171 - .../models/UnlinkedPATemplateSummaryRoot.java | 146 - .../UnlinkedPATemplateUpdateParameters.java | 419 - ...nlinkedPATemplateUpdateParametersRoot.java | 141 - .../VaultAttributionLoaderResponse.java | 171 + ...> VaultAttributionLoaderResponseRoot.java} | 30 +- 212 files changed, 8375 insertions(+), 46024 deletions(-) delete mode 100644 auto-generated-sdk/docs/Column.md delete mode 100644 auto-generated-sdk/docs/ColumnRoot.md delete mode 100644 auto-generated-sdk/docs/ColumnStatistic.md delete mode 100644 auto-generated-sdk/docs/ColumnStatisticRoot.md delete mode 100644 auto-generated-sdk/docs/ColumnSummary.md delete mode 100644 auto-generated-sdk/docs/ColumnsApi.md create mode 100644 auto-generated-sdk/docs/FIConvertibleSettings.md delete mode 100644 auto-generated-sdk/docs/FPOAccount.md delete mode 100644 auto-generated-sdk/docs/FPOObjective.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizationParameters.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizationParametersRoot.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategy.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md delete mode 100644 auto-generated-sdk/docs/FpoOptimizerApi.md delete mode 100644 auto-generated-sdk/docs/Group.md delete mode 100644 auto-generated-sdk/docs/GroupRoot.md delete mode 100644 auto-generated-sdk/docs/GroupsApi.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplate.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateParameters.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummary.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummary.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPaTemplatesApi.md delete mode 100644 auto-generated-sdk/docs/PACalculationColumn.md delete mode 100644 auto-generated-sdk/docs/PACalculationDataSources.md delete mode 100644 auto-generated-sdk/docs/PACalculationGroup.md delete mode 100644 auto-generated-sdk/docs/PACalculationParameters.md delete mode 100644 auto-generated-sdk/docs/PACalculationParametersRoot.md delete mode 100644 auto-generated-sdk/docs/PACalculationPricingSource.md delete mode 100644 auto-generated-sdk/docs/PAComponent.md delete mode 100644 auto-generated-sdk/docs/PAComponentData.md delete mode 100644 auto-generated-sdk/docs/PAComponentRoot.md delete mode 100644 auto-generated-sdk/docs/PADateParameters.md delete mode 100644 auto-generated-sdk/docs/PAIdentifier.md delete mode 100644 auto-generated-sdk/docs/PAPricingSource.md delete mode 100644 auto-generated-sdk/docs/PAPricingSourceRoot.md delete mode 100644 auto-generated-sdk/docs/PaCalculationsApi.md delete mode 100644 auto-generated-sdk/docs/PaDoc.md delete mode 100644 auto-generated-sdk/docs/PricingSourcesApi.md delete mode 100644 auto-generated-sdk/docs/QuantDateListObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantFdsDateObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantFqlExpressionObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/TemplateContentTypes.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponent.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParameters.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummary.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPaComponentsApi.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplate.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParameters.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummary.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md rename auto-generated-sdk/docs/{ColumnStatisticsApi.md => VaultAttributionLoaderApi.md} (60%) create mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderResponse.md rename auto-generated-sdk/docs/{ColumnSummaryRoot.md => VaultAttributionLoaderResponseRoot.md} (61%) delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java rename auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/{ColumnStatisticsApi.java => VaultAttributionLoaderApi.java} (59%) delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java rename auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/{TemplatedPAComponentParametersRoot.java => VaultAttributionLoaderResponseRoot.java} (73%) diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index 5d30cbea..d4327b1c 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -37,14 +37,6 @@ docs/CalculationUnitStatusMeta.md docs/CalculationsSummary.md docs/CalculationsSummaryRoot.md docs/ClientErrorResponse.md -docs/Column.md -docs/ColumnRoot.md -docs/ColumnStatistic.md -docs/ColumnStatisticRoot.md -docs/ColumnStatisticsApi.md -docs/ColumnSummary.md -docs/ColumnSummaryRoot.md -docs/ColumnsApi.md docs/ComponentSummary.md docs/ComponentSummaryRoot.md docs/ComponentsApi.md @@ -76,6 +68,7 @@ docs/FIBankLoans.md docs/FICalculationParameters.md docs/FICalculationParametersRoot.md docs/FICashflows.md +docs/FIConvertibleSettings.md docs/FIDiscountCurveInfo.md docs/FIDiscountCurveInfoRoot.md docs/FIJobSettings.md @@ -92,32 +85,11 @@ docs/FIServicerAdvances.md docs/FIServicerAdvancesForSecurities.md docs/FIStructuredProductsForJobSettings.md docs/FIStructuredProductsForSecurities.md -docs/FPOAccount.md -docs/FPOObjective.md -docs/FPOOptimizationParameters.md -docs/FPOOptimizationParametersRoot.md -docs/FPOOptimizerStrategy.md -docs/FPOOptimizerStrategyOverrides.md docs/FiCalculationsApi.md docs/FiabCalculationsApi.md -docs/FpoOptimizerApi.md docs/FrequenciesApi.md docs/Frequency.md docs/FrequencyRoot.md -docs/Group.md -docs/GroupRoot.md -docs/GroupsApi.md -docs/LinkedPATemplate.md -docs/LinkedPATemplateParameters.md -docs/LinkedPATemplateParametersRoot.md -docs/LinkedPATemplatePostSummary.md -docs/LinkedPATemplatePostSummaryRoot.md -docs/LinkedPATemplateRoot.md -docs/LinkedPATemplateSummary.md -docs/LinkedPATemplateSummaryRoot.md -docs/LinkedPATemplateUpdateParameters.md -docs/LinkedPATemplateUpdateParametersRoot.md -docs/LinkedPaTemplatesApi.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerStrategy.md @@ -134,24 +106,8 @@ docs/OptimizerAccountOverrides.md docs/OptimizerOptimalHoldings.md docs/OptimizerOutputTypes.md docs/OptimizerTradesList.md -docs/PACalculationColumn.md -docs/PACalculationDataSources.md -docs/PACalculationGroup.md -docs/PACalculationParameters.md -docs/PACalculationParametersRoot.md -docs/PACalculationPricingSource.md -docs/PAComponent.md -docs/PAComponentData.md -docs/PAComponentRoot.md -docs/PADateParameters.md -docs/PAIdentifier.md -docs/PAPricingSource.md -docs/PAPricingSourceRoot.md -docs/PaCalculationsApi.md -docs/PaDoc.md docs/PaginationInfo.md docs/PaginationMeta.md -docs/PricingSourcesApi.md docs/PubCalculationParameters.md docs/PubCalculationParametersRoot.md docs/PubCalculationsApi.md @@ -164,22 +120,14 @@ docs/QuantCalculationParametersRoot.md docs/QuantCalculationsApi.md docs/QuantDate.md docs/QuantDateList.md -docs/QuantDateListObsolete.md docs/QuantFdsDate.md -docs/QuantFdsDateObsolete.md docs/QuantFormula.md docs/QuantFqlExpression.md -docs/QuantFqlExpressionObsolete.md docs/QuantIdentifierUniverse.md -docs/QuantIdentifierUniverseObsolete.md docs/QuantScreeningExpression.md -docs/QuantScreeningExpressionObsolete.md docs/QuantScreeningExpressionUniverse.md -docs/QuantScreeningExpressionUniverseObsolete.md docs/QuantUniversalScreenParameter.md -docs/QuantUniversalScreenParameterObsolete.md docs/QuantUniversalScreenUniverse.md -docs/QuantUniversalScreenUniverseObsolete.md docs/QuantUniverse.md docs/ReturnType.md docs/SPARAccounts.md @@ -194,35 +142,9 @@ docs/SPARDateParameters.md docs/SPARIdentifier.md docs/SparCalculationsApi.md docs/StrategyDocumentsApi.md -docs/TemplateContentTypes.md -docs/TemplatedPAComponent.md -docs/TemplatedPAComponentParameters.md -docs/TemplatedPAComponentParametersRoot.md -docs/TemplatedPAComponentPostSummary.md -docs/TemplatedPAComponentPostSummaryRoot.md -docs/TemplatedPAComponentRoot.md -docs/TemplatedPAComponentSummary.md -docs/TemplatedPAComponentSummaryRoot.md -docs/TemplatedPAComponentUpdateParameters.md -docs/TemplatedPAComponentUpdateParametersRoot.md -docs/TemplatedPaComponentsApi.md -docs/UnlinkedPATemplate.md -docs/UnlinkedPATemplateCategoryAndType.md -docs/UnlinkedPATemplateCategoryAndTypeDetails.md -docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md -docs/UnlinkedPATemplateCategoryAndTypeRoot.md -docs/UnlinkedPATemplateColumnDetails.md -docs/UnlinkedPATemplateGroupDetails.md -docs/UnlinkedPATemplateParameters.md -docs/UnlinkedPATemplateParametersRoot.md -docs/UnlinkedPATemplatePostSummary.md -docs/UnlinkedPATemplatePostSummaryRoot.md -docs/UnlinkedPATemplateRoot.md -docs/UnlinkedPATemplateSummary.md -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 @@ -260,8 +182,6 @@ 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 src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -270,19 +190,13 @@ src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java -src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java -src/main/java/factset/analyticsapi/engines/api/GroupsApi.java -src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java -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/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 @@ -316,12 +230,6 @@ src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java src/main/java/factset/analyticsapi/engines/models/CalculationsSummary.java src/main/java/factset/analyticsapi/engines/models/CalculationsSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java -src/main/java/factset/analyticsapi/engines/models/Column.java -src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java -src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java -src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java -src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java -src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java @@ -347,6 +255,7 @@ src/main/java/factset/analyticsapi/engines/models/FIBankLoans.java src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/FICashflows.java +src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java src/main/java/factset/analyticsapi/engines/models/FIDiscountCurveInfo.java src/main/java/factset/analyticsapi/engines/models/FIDiscountCurveInfoRoot.java src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java @@ -363,26 +272,8 @@ src/main/java/factset/analyticsapi/engines/models/FIServicerAdvances.java src/main/java/factset/analyticsapi/engines/models/FIServicerAdvancesForSecurities.java src/main/java/factset/analyticsapi/engines/models/FIStructuredProductsForJobSettings.java src/main/java/factset/analyticsapi/engines/models/FIStructuredProductsForSecurities.java -src/main/java/factset/analyticsapi/engines/models/FPOAccount.java -src/main/java/factset/analyticsapi/engines/models/FPOObjective.java -src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java -src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java -src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java src/main/java/factset/analyticsapi/engines/models/Frequency.java src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java -src/main/java/factset/analyticsapi/engines/models/Group.java -src/main/java/factset/analyticsapi/engines/models/GroupRoot.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java -src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java @@ -398,20 +289,6 @@ src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java -src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java -src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java -src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java -src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java -src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java -src/main/java/factset/analyticsapi/engines/models/PAComponent.java -src/main/java/factset/analyticsapi/engines/models/PAComponentData.java -src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java -src/main/java/factset/analyticsapi/engines/models/PADateParameters.java -src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java -src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java -src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java -src/main/java/factset/analyticsapi/engines/models/PaDoc.java src/main/java/factset/analyticsapi/engines/models/PaginationInfo.java src/main/java/factset/analyticsapi/engines/models/PaginationMeta.java src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java @@ -424,22 +301,14 @@ src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.jav src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/QuantDate.java src/main/java/factset/analyticsapi/engines/models/QuantDateList.java -src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java -src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantFormula.java src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java -src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java -src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java -src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java -src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java -src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java 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 @@ -452,33 +321,8 @@ src/main/java/factset/analyticsapi/engines/models/SPARComponent.java src/main/java/factset/analyticsapi/engines/models/SPARComponentRoot.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/TemplateContentTypes.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java -src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java -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 944d98a4..4b27a563 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -42,7 +42,7 @@ Add this dependency to your project's POM: com.factset.analyticsapi engines-sdk - 6.2.0 + 6.3.0-rc.1 compile ``` @@ -52,7 +52,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "com.factset.analyticsapi:engines-sdk:6.2.0" +compile "com.factset.analyticsapi:engines-sdk:6.3.0-rc.1" ``` ### Others @@ -65,7 +65,7 @@ mvn clean package Then manually install the following JARs: -- `target/engines-sdk-6.2.0.jar` +- `target/engines-sdk-6.3.0-rc.1.jar` - `target/lib/*.jar` ## Usage @@ -162,11 +162,6 @@ Class | Method | HTTP request | Description *BpmOptimizerApi* | [**getOptimizationStatusById**](docs/BpmOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/bpm/v3/optimizations/{id}/status | Get BPM optimization status by id *BpmOptimizerApi* | [**postAndOptimize**](docs/BpmOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/bpm/v3/optimizations | Create and Run BPM optimization *BpmOptimizerApi* | [**putAndOptimize**](docs/BpmOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/bpm/v3/optimizations/{id} | Create or Update BPM optimization and run it. -*ColumnStatisticsApi* | [**getPAColumnStatistics**](docs/ColumnStatisticsApi.md#getPAColumnStatistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics -*ColumnsApi* | [**getPAColumnById**](docs/ColumnsApi.md#getPAColumnById) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings -*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* | [**getSPARComponentById**](docs/ComponentsApi.md#getSPARComponentById) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id *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 @@ -174,10 +169,8 @@ Class | Method | HTTP request | Description *ConfigurationsApi* | [**getVaultConfigurationById**](docs/ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**getVaultConfigurations**](docs/ConfigurationsApi.md#getVaultConfigurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**getCurrencies**](docs/CurrenciesApi.md#getCurrencies) | **GET** /analytics/lookups/v3/currencies | Get currencies -*DatesApi* | [**convertPADatesToAbsoluteFormat**](docs/DatesApi.md#convertPADatesToAbsoluteFormat) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format *DatesApi* | [**convertVaultDatesToAbsoluteFormat**](docs/DatesApi.md#convertVaultDatesToAbsoluteFormat) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format *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 @@ -190,36 +183,14 @@ Class | Method | HTTP request | Description *FiabCalculationsApi* | [**getCalculationById**](docs/FiabCalculationsApi.md#getCalculationById) | **GET** /analytics/engines/fiab/v1/calculations/{id} | Get FIAB calculation by id *FiabCalculationsApi* | [**getCalculationStatusSummaries**](docs/FiabCalculationsApi.md#getCalculationStatusSummaries) | **GET** /analytics/engines/fiab/v1/calculations | Get all FIAB calculation summaries *FiabCalculationsApi* | [**runCalculation**](docs/FiabCalculationsApi.md#runCalculation) | **POST** /analytics/engines/fiab/v1/calculations | Run FIAB calculation -*FpoOptimizerApi* | [**cancelOptimizationById**](docs/FpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id -*FpoOptimizerApi* | [**getOptimizationParameters**](docs/FpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id -*FpoOptimizerApi* | [**getOptimizationResult**](docs/FpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id -*FpoOptimizerApi* | [**getOptimizationStatusById**](docs/FpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id -*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 -*LinkedPaTemplatesApi* | [**createLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template -*LinkedPaTemplatesApi* | [**deleteLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. -*LinkedPaTemplatesApi* | [**getLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates -*LinkedPaTemplatesApi* | [**getLinkedPATemplatesById**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id -*LinkedPaTemplatesApi* | [**updateLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template *NpoOptimizerApi* | [**cancelOptimizationById**](docs/NpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/npo/v3/optimizations/{id} | Cancel NPO optimization by id *NpoOptimizerApi* | [**getOptimizationParameters**](docs/NpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/npo/v3/optimizations/{id} | Get NPO optimization parameters by id *NpoOptimizerApi* | [**getOptimizationResult**](docs/NpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/npo/v3/optimizations/{id}/result | Get NPO optimization result by id *NpoOptimizerApi* | [**getOptimizationStatusById**](docs/NpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/npo/v3/optimizations/{id}/status | Get NPO optimization status by id *NpoOptimizerApi* | [**postAndOptimize**](docs/NpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NpoOptimizerApi* | [**putAndOptimize**](docs/NpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. -*PaCalculationsApi* | [**cancelCalculationById**](docs/PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -*PaCalculationsApi* | [**getAllCalculations**](docs/PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations -*PaCalculationsApi* | [**getCalculationParameters**](docs/PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id -*PaCalculationsApi* | [**getCalculationStatusById**](docs/PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id -*PaCalculationsApi* | [**getCalculationUnitResultById**](docs/PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -*PaCalculationsApi* | [**postAndCalculate**](docs/PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation -*PaCalculationsApi* | [**putAndCalculate**](docs/PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. -*PricingSourcesApi* | [**getPAPricingSources**](docs/PricingSourcesApi.md#getPAPricingSources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources *PubCalculationsApi* | [**cancelCalculationById**](docs/PubCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pub/v3/calculations/{id} | Cancel Pub calculation by id *PubCalculationsApi* | [**getAllCalculations**](docs/PubCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pub/v3/calculations | Get all calculations *PubCalculationsApi* | [**getCalculationParameters**](docs/PubCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pub/v3/calculations/{id} | Get Pub calculation parameters by id @@ -245,20 +216,8 @@ Class | Method | HTTP request | Description *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 -*StrategyDocumentsApi* | [**getFPOStrategyDocuments**](docs/StrategyDocumentsApi.md#getFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**getNorthfieldStrategyDocuments**](docs/StrategyDocumentsApi.md#getNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory -*TemplatedPaComponentsApi* | [**createTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component -*TemplatedPaComponentsApi* | [**deleteTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component -*TemplatedPaComponentsApi* | [**getTemplatedPAComponentById**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id -*TemplatedPaComponentsApi* | [**getTemplatedPAComponentsInPath**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path -*TemplatedPaComponentsApi* | [**updateTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component -*UnlinkedPaTemplatesApi* | [**createUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template -*UnlinkedPaTemplatesApi* | [**deleteUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template -*UnlinkedPaTemplatesApi* | [**getDefaultUnlinkedPATemplateTypes**](docs/UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. -*UnlinkedPaTemplatesApi* | [**getDetailsType**](docs/UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. -*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 @@ -297,12 +256,6 @@ Class | Method | HTTP request | Description - [CalculationsSummary](docs/CalculationsSummary.md) - [CalculationsSummaryRoot](docs/CalculationsSummaryRoot.md) - [ClientErrorResponse](docs/ClientErrorResponse.md) - - [Column](docs/Column.md) - - [ColumnRoot](docs/ColumnRoot.md) - - [ColumnStatistic](docs/ColumnStatistic.md) - - [ColumnStatisticRoot](docs/ColumnStatisticRoot.md) - - [ColumnSummary](docs/ColumnSummary.md) - - [ColumnSummaryRoot](docs/ColumnSummaryRoot.md) - [ComponentSummary](docs/ComponentSummary.md) - [ComponentSummaryRoot](docs/ComponentSummaryRoot.md) - [ConfigurationAccount](docs/ConfigurationAccount.md) @@ -328,6 +281,7 @@ Class | Method | HTTP request | Description - [FICalculationParameters](docs/FICalculationParameters.md) - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md) - [FICashflows](docs/FICashflows.md) + - [FIConvertibleSettings](docs/FIConvertibleSettings.md) - [FIDiscountCurveInfo](docs/FIDiscountCurveInfo.md) - [FIDiscountCurveInfoRoot](docs/FIDiscountCurveInfoRoot.md) - [FIJobSettings](docs/FIJobSettings.md) @@ -344,26 +298,8 @@ Class | Method | HTTP request | Description - [FIServicerAdvancesForSecurities](docs/FIServicerAdvancesForSecurities.md) - [FIStructuredProductsForJobSettings](docs/FIStructuredProductsForJobSettings.md) - [FIStructuredProductsForSecurities](docs/FIStructuredProductsForSecurities.md) - - [FPOAccount](docs/FPOAccount.md) - - [FPOObjective](docs/FPOObjective.md) - - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md) - - [FPOOptimizationParametersRoot](docs/FPOOptimizationParametersRoot.md) - - [FPOOptimizerStrategy](docs/FPOOptimizerStrategy.md) - - [FPOOptimizerStrategyOverrides](docs/FPOOptimizerStrategyOverrides.md) - [Frequency](docs/Frequency.md) - [FrequencyRoot](docs/FrequencyRoot.md) - - [Group](docs/Group.md) - - [GroupRoot](docs/GroupRoot.md) - - [LinkedPATemplate](docs/LinkedPATemplate.md) - - [LinkedPATemplateParameters](docs/LinkedPATemplateParameters.md) - - [LinkedPATemplateParametersRoot](docs/LinkedPATemplateParametersRoot.md) - - [LinkedPATemplatePostSummary](docs/LinkedPATemplatePostSummary.md) - - [LinkedPATemplatePostSummaryRoot](docs/LinkedPATemplatePostSummaryRoot.md) - - [LinkedPATemplateRoot](docs/LinkedPATemplateRoot.md) - - [LinkedPATemplateSummary](docs/LinkedPATemplateSummary.md) - - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) - - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) - - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -379,20 +315,6 @@ Class | Method | HTTP request | Description - [OptimizerOptimalHoldings](docs/OptimizerOptimalHoldings.md) - [OptimizerOutputTypes](docs/OptimizerOutputTypes.md) - [OptimizerTradesList](docs/OptimizerTradesList.md) - - [PACalculationColumn](docs/PACalculationColumn.md) - - [PACalculationDataSources](docs/PACalculationDataSources.md) - - [PACalculationGroup](docs/PACalculationGroup.md) - - [PACalculationParameters](docs/PACalculationParameters.md) - - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) - - [PACalculationPricingSource](docs/PACalculationPricingSource.md) - - [PAComponent](docs/PAComponent.md) - - [PAComponentData](docs/PAComponentData.md) - - [PAComponentRoot](docs/PAComponentRoot.md) - - [PADateParameters](docs/PADateParameters.md) - - [PAIdentifier](docs/PAIdentifier.md) - - [PAPricingSource](docs/PAPricingSource.md) - - [PAPricingSourceRoot](docs/PAPricingSourceRoot.md) - - [PaDoc](docs/PaDoc.md) - [PaginationInfo](docs/PaginationInfo.md) - [PaginationMeta](docs/PaginationMeta.md) - [PubCalculationParameters](docs/PubCalculationParameters.md) @@ -405,22 +327,14 @@ Class | Method | HTTP request | Description - [QuantCalculationParametersRoot](docs/QuantCalculationParametersRoot.md) - [QuantDate](docs/QuantDate.md) - [QuantDateList](docs/QuantDateList.md) - - [QuantDateListObsolete](docs/QuantDateListObsolete.md) - [QuantFdsDate](docs/QuantFdsDate.md) - - [QuantFdsDateObsolete](docs/QuantFdsDateObsolete.md) - [QuantFormula](docs/QuantFormula.md) - [QuantFqlExpression](docs/QuantFqlExpression.md) - - [QuantFqlExpressionObsolete](docs/QuantFqlExpressionObsolete.md) - [QuantIdentifierUniverse](docs/QuantIdentifierUniverse.md) - - [QuantIdentifierUniverseObsolete](docs/QuantIdentifierUniverseObsolete.md) - [QuantScreeningExpression](docs/QuantScreeningExpression.md) - - [QuantScreeningExpressionObsolete](docs/QuantScreeningExpressionObsolete.md) - [QuantScreeningExpressionUniverse](docs/QuantScreeningExpressionUniverse.md) - - [QuantScreeningExpressionUniverseObsolete](docs/QuantScreeningExpressionUniverseObsolete.md) - [QuantUniversalScreenParameter](docs/QuantUniversalScreenParameter.md) - - [QuantUniversalScreenParameterObsolete](docs/QuantUniversalScreenParameterObsolete.md) - [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md) - - [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md) - [QuantUniverse](docs/QuantUniverse.md) - [ReturnType](docs/ReturnType.md) - [SPARAccounts](docs/SPARAccounts.md) @@ -433,33 +347,8 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) - - [TemplateContentTypes](docs/TemplateContentTypes.md) - - [TemplatedPAComponent](docs/TemplatedPAComponent.md) - - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) - - [TemplatedPAComponentParametersRoot](docs/TemplatedPAComponentParametersRoot.md) - - [TemplatedPAComponentPostSummary](docs/TemplatedPAComponentPostSummary.md) - - [TemplatedPAComponentPostSummaryRoot](docs/TemplatedPAComponentPostSummaryRoot.md) - - [TemplatedPAComponentRoot](docs/TemplatedPAComponentRoot.md) - - [TemplatedPAComponentSummary](docs/TemplatedPAComponentSummary.md) - - [TemplatedPAComponentSummaryRoot](docs/TemplatedPAComponentSummaryRoot.md) - - [TemplatedPAComponentUpdateParameters](docs/TemplatedPAComponentUpdateParameters.md) - - [TemplatedPAComponentUpdateParametersRoot](docs/TemplatedPAComponentUpdateParametersRoot.md) - - [UnlinkedPATemplate](docs/UnlinkedPATemplate.md) - - [UnlinkedPATemplateCategoryAndType](docs/UnlinkedPATemplateCategoryAndType.md) - - [UnlinkedPATemplateCategoryAndTypeDetails](docs/UnlinkedPATemplateCategoryAndTypeDetails.md) - - [UnlinkedPATemplateCategoryAndTypeDetailsRoot](docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) - - [UnlinkedPATemplateCategoryAndTypeRoot](docs/UnlinkedPATemplateCategoryAndTypeRoot.md) - - [UnlinkedPATemplateColumnDetails](docs/UnlinkedPATemplateColumnDetails.md) - - [UnlinkedPATemplateGroupDetails](docs/UnlinkedPATemplateGroupDetails.md) - - [UnlinkedPATemplateParameters](docs/UnlinkedPATemplateParameters.md) - - [UnlinkedPATemplateParametersRoot](docs/UnlinkedPATemplateParametersRoot.md) - - [UnlinkedPATemplatePostSummary](docs/UnlinkedPATemplatePostSummary.md) - - [UnlinkedPATemplatePostSummaryRoot](docs/UnlinkedPATemplatePostSummaryRoot.md) - - [UnlinkedPATemplateRoot](docs/UnlinkedPATemplateRoot.md) - - [UnlinkedPATemplateSummary](docs/UnlinkedPATemplateSummary.md) - - [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 40fee24c..3bf80c32 100644 --- a/auto-generated-sdk/api/openapi.yaml +++ b/auto-generated-sdk/api/openapi.yaml @@ -6730,42 +6730,20 @@ paths: - status-code: "200" response-type: ObjectRoot x-accepts: application/json - /analytics/engines/pa/v3/columns: + /analytics/engines/spar/v3/components: get: - description: This endpoint lists all the PA columns that can be applied to a - calculation. - operationId: getPAColumns + description: This endpoint returns the list of SPAR components in a given SPAR + document. + operationId: getSPARComponents parameters: - - description: Column name - explode: true - in: query - name: name - required: false - schema: - default: "" - description: Column name - example: Security Name - type: string - style: form - - description: Column category - explode: true - in: query - name: category - required: false - schema: - default: "" - description: Column category - type: string - style: form - - description: The directory to get the columns in + - description: Document Name explode: true in: query - name: directory - required: false + name: document + required: true schema: - default: "" - description: The directory to get the columns in - example: Client + description: Document Name + example: SPAR_DOCUMENTS:Factset Default Document type: string style: form responses: @@ -6773,8 +6751,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ColumnSummaryRoot' - description: Expected response, returns a list of PA columns + $ref: '#/components/schemas/ComponentSummaryRoot' + description: Expected response, returns a list of SPAR components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -6792,14 +6770,87 @@ paths: available after successful authentication. type: string style: simple - Age: - description: Standard HTTP header. Header will specify the age of columns - list cached response. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: Standard HTTP header. Header will specify the age of - columns list cached response. - type: integer + 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 provided or Invalid SPAR document name. + 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: SPAR Document 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. @@ -6941,7 +6992,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. @@ -6978,27 +7029,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA columns + summary: Get SPAR components tags: - - Columns + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ColumnSummaryRoot + response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/engines/pa/v3/columns/{id}: + /analytics/engines/spar/v3/components/{id}: get: - description: This endpoint returns the default settings of a PA column. - operationId: getPAColumnById + description: This endpoint returns the default settings of a SPAR component. + operationId: getSPARComponentById parameters: - - description: Unique identifier for a column + - description: Unique identifier for a SPAR component explode: false in: path name: id required: true schema: - description: Unique identifier for a column - example: 2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7 + description: Unique identifier for a SPAR component + example: 067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D type: string style: simple responses: @@ -7006,8 +7057,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ColumnRoot' - description: Expected response, returns settings of a PA column. + $ref: '#/components/schemas/SPARComponentRoot' + description: Expected response, returns the default settings of a SPAR component. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7025,15 +7076,6 @@ paths: available after successful authentication. type: string style: simple - Age: - description: Standard HTTP header. Header will specify the age of columns - list cached response. - explode: false - schema: - description: Standard HTTP header. Header will specify the age of - columns list cached response. - type: integer - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -7057,7 +7099,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid column Id. + description: Invalid SPAR component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7098,7 +7140,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Column not found. + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7293,26 +7335,120 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA column settings + summary: Get SPAR component by id tags: - - Columns + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ColumnRoot + response-type: SPARComponentRoot x-accepts: application/json - /analytics/engines/pa/v3/columnstatistics: + /analytics/engines/vault/v3/components: get: - description: This endpoint lists all the column statistics that can be applied - to a PA column. - operationId: getPAColumnStatistics + description: This endpoint returns the list of Vault components in a given Vault + document. + operationId: getVaultComponents + parameters: + - description: Document Name + explode: true + in: query + name: document + required: true + schema: + description: Document Name + example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ColumnStatisticRoot' - description: Expected response, returns a list of PA column statistics + $ref: '#/components/schemas/ComponentSummaryRoot' + description: Expected response, returns a list of Vault components. + 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 provided or invalid Vault document + name. + 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: Vault Document not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7470,7 +7606,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. @@ -7507,36 +7643,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA column statistics + summary: Get Vault components tags: - - ColumnStatistics + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ColumnStatisticRoot + response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/engines/pa/v3/components: + /analytics/engines/vault/v3/components/{id}: get: - description: This endpoint returns the list of PA components in a given PA document. - operationId: getPAComponents + 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 - example: PA3_DOCUMENTS:DEFAULT + description: Unique identifier for a vault component + example: AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D type: string - style: form + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of PA 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. @@ -7577,7 +7714,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter provided or Invalid PA document name. + description: Invalid Vault component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7618,7 +7755,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Document not found. + description: Vault Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7813,36 +7950,39 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA 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/pa/v3/components/{id}: + /analytics/engines/vault/v3/configurations: get: - description: This endpoint returns the default settings of a PA component. - operationId: getPAComponentById + description: This endpoint returns all the Vault configurations saved in the + provided account. + operationId: getVaultConfigurations parameters: - - description: Unique identifier for a PA 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 PA component - example: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46 + description: Required account query parameter to filter configurations for + a specific account + example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PAComponentRoot' - description: Expected response, returns the default settings of a PA 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. @@ -7883,7 +8023,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid PA component id. + description: Invalid account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7924,7 +8064,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Component not found. + description: Account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8119,37 +8259,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA 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: PAComponentRoot + response-type: VaultConfigurationSummaryRoot x-accepts: application/json - /analytics/engines/spar/v3/components: + /analytics/engines/vault/v3/configurations/{id}: get: - description: This endpoint returns the list of SPAR components in a given SPAR - document. - operationId: getSPARComponents + description: This endpoint returns details for a Vault configuration as well + as a list of accounts it is used in. + operationId: getVaultConfigurationById parameters: - - description: Document Name - explode: true - in: query - name: document + - description: Vault configuration id to get the details of + explode: false + in: path + name: id required: true schema: - description: Document Name - example: SPAR_DOCUMENTS:Factset Default Document + description: Vault configuration id to get the details of + example: e95ef921-b4d4-4bb7-93ba-60eca8e3247a type: string - style: form + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of SPAR components. + $ref: '#/components/schemas/VaultConfigurationRoot' + description: Expected response, returns details for a Vault configuration. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8190,7 +8330,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter provided or Invalid SPAR document name. + description: Invalid vault configuration code. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8231,7 +8371,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: SPAR Document not found. + description: Vault configuration id not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8426,118 +8566,26 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR components + summary: Get Vault configuration by id tags: - - Components + - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ComponentSummaryRoot + response-type: VaultConfigurationRoot x-accepts: application/json - /analytics/engines/spar/v3/components/{id}: + /analytics/lookups/v3/currencies: get: - description: This endpoint returns the default settings of a SPAR component. - operationId: getSPARComponentById - parameters: - - description: Unique identifier for a SPAR component - explode: false - in: path - name: id - required: true - schema: - description: Unique identifier for a SPAR component - example: 067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D - 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/SPARComponentRoot' - description: Expected response, returns the default settings of a SPAR component. - 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 SPAR component id. - 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: Component not found. + $ref: '#/components/schemas/CurrencyRoot' + description: Expected response, returns a list of currencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8732,27 +8780,56 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR component by id + summary: Get currencies tags: - - Components + - Currencies x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: SPARComponentRoot + response-type: CurrencyRoot x-accepts: application/json - /analytics/engines/vault/v3/components: + /analytics/engines/vault/v3/dates: get: - description: This endpoint returns the list of Vault components in a given Vault - document. - operationId: getVaultComponents + 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 parameters: - - description: Document Name + - description: Start Date explode: true in: query - name: document + name: startdate + required: false + schema: + description: Start Date + type: string + style: form + - description: End Date + explode: true + in: query + name: enddate required: true schema: - description: Document Name + 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: @@ -8760,8 +8837,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of Vault components. + $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. @@ -8802,8 +8880,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter provided or invalid Vault document - name. + description: Invalid query parameter or value is provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8844,7 +8921,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault Document not found. + description: vault Document or account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9039,36 +9116,34 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault components + summary: Convert Vault dates to absolute format tags: - - Components + - Dates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ComponentSummaryRoot + response-type: DateParametersSummaryRoot x-accepts: application/json - /analytics/engines/vault/v3/components/{id}: + /analytics/engines/fi/v3/discount-curves: get: - description: This endpoint returns the default settings of a Vault component. - operationId: getVaultComponentById + description: This endpoint lists all the discount curves that can be applied + to a FI calculation. + operationId: getAllFIDiscountCurves parameters: - - description: Unique identifier for a vault component - explode: false - in: path - name: id - required: true + - explode: true + in: query + name: currency + required: false schema: - description: Unique identifier for a vault component 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/FIDiscountCurveInfoRoot' + description: Expected response, returns a list of FI discount curves. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9104,53 +9179,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Vault component id. - 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: Vault Component not found. + description: Not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9345,38 +9379,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault component by id + summary: Get Discount Curves tags: - - Components + - DiscountCurves x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultComponentRoot + response-type: FIDiscountCurveInfoRoot x-accepts: application/json - /analytics/engines/vault/v3/configurations: + /analytics/engines/vault/v3/documents/{path}: get: - description: This endpoint returns all the Vault configurations saved in the - provided account. - operationId: getVaultConfigurations + description: This endpoint looks up all Vault documents and sub-directories + in a given directory. + operationId: getVaultDocuments parameters: - - description: Required account query parameter to filter configurations for - a specific account - explode: true - in: query - name: account + - description: The directory to get the documents in + explode: false + in: path + name: path required: true schema: - description: Required account query parameter to filter configurations for - a specific account + description: The directory to get the documents in + example: 'Client:' 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/DocumentDirectoriesRoot' + description: Expected response, returns a list of Vault documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9417,7 +9450,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. @@ -9458,7 +9491,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. @@ -9495,7 +9528,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. @@ -9551,7 +9584,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. @@ -9616,7 +9649,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. @@ -9635,7 +9668,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. @@ -9653,27 +9686,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configurations + summary: Get Vault documents and sub-directories in a directory tags: - - Configurations + - Documents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationSummaryRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/vault/v3/configurations/{id}: + /analytics/engines/spar/v3/documents/{path}: get: - description: This endpoint returns details for a Vault configuration as well - as a list of accounts it is used in. - operationId: getVaultConfigurationById + description: This endpoint looks up all SPAR3 documents and sub-directories + in a given directory. + operationId: getSPAR3Documents parameters: - - description: Vault configuration id to get the details of + - description: The directory to get the documents in explode: false in: path - name: id + name: path required: true schema: - description: Vault configuration id to get the details of + description: The directory to get the documents in + example: 'Client:' type: string style: simple responses: @@ -9681,8 +9715,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VaultConfigurationRoot' - description: Expected response, returns details for a Vault configuration. + $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. @@ -9723,7 +9757,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid vault configuration code. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9764,7 +9798,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault configuration id not found. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9801,7 +9835,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. @@ -9857,7 +9891,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. @@ -9922,7 +9956,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. @@ -9941,7 +9975,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. @@ -9959,26 +9993,120 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configuration by id + summary: Gets SPAR3 documents and sub-directories in a directory tags: - - Configurations + - Documents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/lookups/v3/currencies: + /analytics/engines/pub/v3/documents/{path}: get: - description: This endpoint lists all the currencies that can be applied to any - calculation. - operationId: getCurrencies + 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: + description: The directory to get the documents in + example: 'Client:' + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CurrencyRoot' - description: Expected response, returns a list of currencies. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Publisher 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 headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10015,7 +10143,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. @@ -10071,7 +10199,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. @@ -10136,7 +10264,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. @@ -10155,7 +10283,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. @@ -10173,152 +10301,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get currencies + summary: Gets Publisher documents and sub-directories in a directory tags: - - Currencies + - Documents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CurrencyRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pa/v3/dates: + /analytics/engines/fiab/v1/calculations: 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 ( Account Name ending with .ACCT or .ACTM ) - explode: true - in: query - name: account - required: true - schema: - description: Account ( Account Name ending with .ACCT or .ACTM ) - example: Client:/Folder1/Folder2/AccountName.ACCT - type: string - style: form + description: This endpoints returns all FIAB calculation requests. + operationId: getCalculationStatusSummaries responses: "200": 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. - 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: Document or account 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. @@ -10374,7 +10377,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. @@ -10513,67 +10516,37 @@ paths: available after successful authentication. type: string style: simple - summary: Convert PA dates to absolute format + summary: Get all FIAB calculation summaries tags: - - Dates + - FIAB Calculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DateParametersSummaryRoot x-accepts: application/json - /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 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 - parameters: - - description: Start Date - explode: true - in: query - name: startdate - 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 + 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/DateParametersSummaryRoot' - description: Expected response, returns the converted dates in yyyymmdd - format. + "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 @@ -10590,6 +10563,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 @@ -10609,12 +10597,15 @@ paths: type: string style: simple "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value is 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 @@ -10631,6 +10622,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 @@ -10649,18 +10655,21 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: vault Document or account not found. + "401": + description: Missing or invalid authentication. headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + Location: + description: URL to check status of the request. explode: false schema: - description: FactSet's request key header. + 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: @@ -10672,27 +10681,31 @@ 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. + "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 - "401": - description: Missing or invalid authentication. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -10709,23 +10722,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: @@ -10746,9 +10755,17 @@ 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: + 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 @@ -10765,6 +10782,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 @@ -10784,9 +10816,16 @@ 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 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 @@ -10803,6 +10842,39 @@ 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 + 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. @@ -10814,6 +10886,13 @@ paths: description: Server error. Log the X-DataDirect-Request-Key header to assist 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 @@ -10830,9 +10909,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 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 @@ -10849,35 +10950,80 @@ paths: available after successful authentication. type: string style: simple - summary: Convert Vault dates to absolute format + 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: - - Dates + - FIAB Calculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: DateParametersSummaryRoot + - status-code: "202" + x-contentType: application/json x-accepts: application/json - /analytics/engines/fi/v3/discount-curves: + /analytics/engines/fiab/v1/calculations/{id}: get: - description: This endpoint lists all the discount curves that can be applied - to a FI calculation. - operationId: getAllFIDiscountCurves + description: This is the endpoint to check on the progress of a previously requested + calculation. + operationId: getCalculationById parameters: - - explode: true - in: query - name: currency - required: false + - 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: 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/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 @@ -10912,13 +11058,23 @@ paths: schema: type: string style: simple - "404": + "202": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Not found + $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 @@ -10953,8 +11109,8 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "400": + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10972,45 +11128,45 @@ 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-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 - 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. + "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-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. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11046,9 +11202,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. @@ -11066,16 +11222,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. @@ -11112,38 +11279,64 @@ paths: available after successful authentication. type: string style: simple - summary: Get Discount Curves + summary: Get FIAB calculation by id tags: - - DiscountCurves + - FIAB Calculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FIDiscountCurveInfoRoot + response-type: FIABCalculationStatus + - status-code: "202" + response-type: FIABCalculationStatus x-accepts: application/json - /analytics/engines/pa/v3/documents/{path}: - get: - description: This endpoint looks up all PA3 documents and sub-directories in - a given directory. - operationId: getPA3Documents + /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: The directory to get the documents and sub-directories in + - description: Long running deadline in seconds. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. explode: false - in: path - name: path - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false schema: - description: The directory to get the documents and sub-directories in - example: 'Client:' type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FICalculationParametersRoot' + description: Calculation Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of PA3 documents and directories + $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 @@ -11160,6 +11353,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 @@ -11178,12 +11385,16 @@ paths: schema: type: string style: simple - "400": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + $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. @@ -11201,6 +11412,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 @@ -11219,12 +11444,15 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11242,6 +11470,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 @@ -11260,8 +11502,15 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication + "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. @@ -11279,23 +11528,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: @@ -11316,8 +11560,8 @@ 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. @@ -11335,27 +11579,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 - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11373,35 +11612,41 @@ 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-Calculations-Limit: + description: Maximum FI request limit. explode: false schema: + description: Maximum FI request limit. 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-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. explode: false schema: - description: FactSet's request key header. + description: Number of FI requests remaining till request limit reached. 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-Limit: + description: Number of allowed requests 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 - "503": - description: Request timed out. Retry the request in some time + 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. @@ -11419,52 +11664,18 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA3 documents and sub-directories in a directory - tags: - - Documents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot - x-accepts: application/json - /analytics/engines/vault/v3/documents/{path}: - get: - 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 in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the documents in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Vault documents and directories - 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: @@ -11485,12 +11696,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + "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. @@ -11508,6 +11716,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 @@ -11526,12 +11748,16 @@ paths: schema: type: string style: simple - "404": - 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: Path not found + 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. @@ -11549,26 +11775,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 + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11586,8 +11808,50 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + 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. @@ -11623,8 +11887,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. @@ -11660,9 +11928,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: 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. @@ -11680,35 +11952,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 some time + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11726,37 +11989,8 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault documents and sub-directories in a directory - tags: - - Documents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot - x-accepts: application/json - /analytics/engines/spar/v3/documents/{path}: - 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: - description: The directory to get the documents in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of SPAR3 documents and directories + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11792,12 +12026,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + "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. @@ -11815,31 +12046,81 @@ 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 - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + 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 @@ -11874,27 +12155,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. @@ -11930,8 +12196,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: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11967,9 +12237,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. @@ -11987,9 +12256,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 @@ -12015,7 +12314,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. @@ -12033,39 +12332,73 @@ paths: available after successful authentication. type: string style: simple - summary: Gets SPAR3 documents and sub-directories in a directory + summary: Get FI calculation parameters by id tags: - - Documents + - FICalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: FICalculationParametersRoot 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 + 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: The directory to get the documents in + - description: from url, provided from the location header in the Create and + Run FI calculation endpoint explode: false in: path - name: path + name: id required: true schema: - description: The directory to get the documents in - example: 'Client:' + 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. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Publisher documents and - directories + $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 @@ -12100,12 +12433,16 @@ paths: schema: type: string style: simple - "400": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + $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. @@ -12141,12 +12478,15 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Calculation Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12182,27 +12522,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 + "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: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12238,8 +12566,15 @@ 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' + 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. @@ -12275,55 +12610,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. @@ -12341,27 +12629,8 @@ paths: available after successful authentication. type: string style: simple - summary: Gets Publisher documents and sub-directories in a directory - tags: - - Documents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot - x-accepts: application/json - /analytics/engines/fiab/v1/calculations: - get: - description: This endpoints returns all FIAB calculation requests. - operationId: getCalculationStatusSummaries - responses: - "200": - content: - application/json: - schema: - additionalProperties: - $ref: '#/components/schemas/FIABCalculationStatusSummary' - type: object - description: List of active FIAB calculation requests. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12397,27 +12666,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. + "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. @@ -12453,8 +12704,9 @@ 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 Calculation + endpoint or wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12490,26 +12742,6 @@ 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. @@ -12556,37 +12788,49 @@ paths: available after successful authentication. type: string style: simple - summary: Get all FIAB calculation summaries + summary: Create or Update FI calculation and run it. tags: - - FIAB Calculations - x-are-multiple-success-responses-different: false + - FICalculations + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "200" + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json x-accepts: application/json - 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' + /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 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: - "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 + "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 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 @@ -12603,21 +12847,6 @@ 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 @@ -12636,16 +12865,26 @@ paths: schema: type: string style: simple - "400": - description: Invalid POST body. + "202": + description: Expected response returned if the calculation is not yet completed, + should contain X-FactSet-Api-PickUp-Progress header. headers: - Location: - description: URL to check status of the request. + X-FactSet-Api-PickUp-Progress: + description: FactSet's progress header. explode: false schema: - description: URL to check status of the request. + 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 @@ -12662,21 +12901,6 @@ 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 @@ -12695,16 +12919,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 identifier provided. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -12721,31 +12945,35 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FIAB request limit. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. 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. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. 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. + 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: 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 @@ -12762,21 +12990,6 @@ 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 @@ -12795,17 +13008,9 @@ 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. - 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 @@ -12822,50 +13027,9 @@ 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 - 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 FIAB - Calculation endpoint or wait for older requests to finish / expire. + "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 @@ -12882,21 +13046,6 @@ 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 @@ -12915,24 +13064,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. + 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 @@ -12949,31 +13084,9 @@ 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 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 @@ -12990,44 +13103,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 - summary: Run FIAB calculation + summary: Get FI calculation status by id tags: - - FIAB Calculations - x-are-multiple-success-responses-different: false + - FICalculations + x-are-multiple-success-responses-different: true x-success-response-types: + - status-code: "201" + response-type: ObjectRoot - status-code: "202" - x-contentType: application/json x-accepts: application/json - /analytics/engines/fiab/v1/calculations/{id}: + /analytics/engines/fi/v3/calculations/{id}/result: get: - description: This is the endpoint to check on the progress of a previously requested - calculation. - operationId: getCalculationById + 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 Run FIAB Calculation - 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 Run FIAB - Calculation endpoint + description: from url, provided from the location header in the Get FI calculation + status by id endpoint type: string style: simple responses: @@ -13035,9 +13135,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FIABCalculationStatus' - description: Expected response, returns status information of the entire - calculation if it is complete. + $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 @@ -13098,23 +13201,16 @@ paths: schema: type: string style: simple - "202": + "400": 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 + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: 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 @@ -13149,8 +13245,16 @@ paths: schema: type: string style: simple - "400": - description: Invalid identifier provided. + "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. @@ -13242,9 +13346,9 @@ paths: schema: type: string style: simple - "404": - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + "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. @@ -13262,27 +13366,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 FI calculation result by id + tags: + - FICalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + 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 + responses: + "200": + content: + application/json: schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + $ref: '#/components/schemas/FrequencyRoot' + description: Expected response, returns a list of SPAR frequencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -13300,83 +13422,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 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. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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 + 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 + "401": + description: Missing or invalid authentication. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -13393,18 +13459,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: @@ -13425,16 +13496,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 calculation 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. @@ -13452,20 +13515,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 @@ -13484,15 +13533,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. @@ -13510,47 +13553,72 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. 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. + "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: Number of FI requests remaining till request limit reached. + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests 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-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 - "404": + 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": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + $ref: '#/components/schemas/FrequencyRoot' + description: Expected response, returns a list of Vault frequencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -13568,20 +13636,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 @@ -13619,20 +13673,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 "403": description: User is forbidden with current credentials headers: @@ -13652,20 +13692,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 @@ -13684,9 +13710,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. @@ -13704,20 +13729,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 @@ -13737,8 +13748,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. @@ -13756,38 +13767,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 - 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. @@ -13815,23 +13794,80 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + "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: 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 - "503": - description: Request timed out. Retry the request in sometime. + 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/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. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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. 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 @@ -13848,50 +13884,31 @@ 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 - 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. + 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -13929,16 +13946,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 optimization parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -13976,17 +13987,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: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14078,9 +14082,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. @@ -14098,8 +14102,27 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -14117,62 +14140,101 @@ paths: 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. + 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: - 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. + "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: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + 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 NPO optimization + 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}: + 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 + 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: + "204": + description: Expected response, optimization was canceled successfully. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -14209,9 +14271,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: @@ -14250,10 +14318,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + 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. @@ -14347,7 +14422,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. @@ -14384,71 +14459,60 @@ paths: available after successful authentication. type: string style: simple - summary: Get FI calculation parameters by id + summary: Cancel NPO optimization by id tags: - - FICalculations + - NPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: FICalculationParametersRoot + - status-code: "204" 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 + 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 FI calculation endpoint + 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 FI calculation endpoint - type: string - style: simple - - description: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + Run NPO optimization endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FICalculationParametersRoot' - description: Calculation Parameters responses: - "202": + "200": 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. + $ref: '#/components/schemas/NPOOptimizationParametersRoot' + description: Expected response, returns the NPO optimization parameters. 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: @@ -14485,16 +14549,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 calculation 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. @@ -14530,15 +14590,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 Calculation Parameters. + description: Optimization id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14574,15 +14631,8 @@ paths: 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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14600,33 +14650,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 - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate calculation exists with same parameters. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14662,8 +14687,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. @@ -14681,8 +14707,8 @@ 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. @@ -14700,6 +14726,86 @@ paths: 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. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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. + 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 @@ -14718,9 +14824,13 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "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. @@ -14756,9 +14866,12 @@ 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: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Optimization Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14794,16 +14907,12 @@ 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: + application/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: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14821,67 +14930,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: Create or Update FI calculation and run it. - 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}/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 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: - "201": + 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/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/ClientErrorResponse' + description: Duplicate optimization exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14917,26 +14989,28 @@ paths: 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. + "401": + description: Missing or invalid authentication. headers: - X-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: FactSet's progress header. + description: FactSet's request key 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. + 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. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer + 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 @@ -14971,15 +15045,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 identifier provided. + "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. @@ -15015,16 +15083,9 @@ paths: schema: type: string style: simple - "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 + "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. @@ -15060,8 +15121,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + 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. @@ -15079,8 +15148,8 @@ 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. @@ -15098,27 +15167,44 @@ 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 + 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: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns JSON. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15136,88 +15222,43 @@ 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 FI calculation status by id - tags: - - FICalculations - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "201" - response-type: ObjectRoot - - status-code: "202" - 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 - parameters: - - 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 Get FI 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-Reset: + description: Number of seconds remaining till rate limit resets. 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. + "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: 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. @@ -15258,9 +15299,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: @@ -15302,11 +15340,8 @@ 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: 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. @@ -15437,103 +15472,65 @@ paths: available after successful authentication. type: string style: simple - summary: Get FI calculation result by id + summary: Get NPO optimization status by id tags: - - FICalculations - x-are-multiple-success-responses-different: false + - NPO Optimizer + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "200" + - status-code: "201" response-type: ObjectRoot + - status-code: "202" 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 + /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: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Get NPO optimization + status by id 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 Get NPO + optimization status by id endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FPOOptimizationParametersRoot' - description: Optimization Parameters responses: - "202": + "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationInfoRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns 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 - 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 - "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 @@ -15573,7 +15570,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid optimization parameters. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15614,7 +15611,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + 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. @@ -15706,9 +15704,9 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "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. @@ -15726,97 +15724,14 @@ 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: - 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. - 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. + description: FactSet's request key header. type: string style: simple X-FactSet-Api-Request-Key: @@ -15828,36 +15743,35 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run FPO optimization + summary: Get NPO optimization result by id tags: - - FPO Optimizer - x-are-multiple-success-responses-different: true + - NPO Optimizer + 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}: - delete: - description: This is the endpoint to cancel a previously submitted optimization. - operationId: cancelOptimizationById + /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 FPO optimization endpoint - explode: false - in: path - name: id - required: true + - explode: true + in: query + name: pageNumber + required: false schema: - description: from url, provided from the location header in the Create and - Run FPO optimization endpoint - type: string - style: simple + default: 1 + format: int32 + type: integer + style: form responses: - "204": - description: Expected response, optimization 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. @@ -15895,16 +15809,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. @@ -15942,17 +15850,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: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16008,7 +15909,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. @@ -16044,28 +15945,8 @@ 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16083,62 +15964,28 @@ paths: 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. - 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 + "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 @@ -16155,30 +16002,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 - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16196,30 +16048,52 @@ 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": + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Optimization id not found + $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. @@ -16255,27 +16129,19 @@ 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 + "201": + content: + application/pdf: schema: - description: FactSet's request key header. + format: binary 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 + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + format: binary type: string - style: simple - "403": - description: User is forbidden with current credentials + 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. @@ -16311,107 +16177,18 @@ 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 FPO optimization parameters by id - tags: - - FPO Optimizer - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: FPOOptimizationParametersRoot - 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 - 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. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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: "202": content: application/json: schema: - $ref: '#/components/schemas/CalculationInfoRoot' + $ref: '#/components/schemas/CalculationStatusRoot' 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 optimization + description: URL to poll for the resulting calculation type: string style: simple X-DataDirect-Request-Key: @@ -16448,13 +16225,12 @@ 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' + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16490,12 +16266,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Optimization Parameters. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16513,30 +16285,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: One or more optimization settings were unavailable. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16572,12 +16322,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 calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16613,27 +16363,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 + "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. @@ -16669,9 +16401,9 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "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. @@ -16707,54 +16439,16 @@ paths: 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. + 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. @@ -16791,99 +16485,39 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update FPO optimization and run it. + summary: Create and Run Pub calculation tags: - - FPO Optimizer + - PubCalculations x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "202" - response-type: CalculationInfoRoot + - status-code: "200" + response-type: CalculationStatusRoot - status-code: "201" - response-type: ObjectRoot + is-file: true + - status-code: "202" + response-type: CalculationStatusRoot 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/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 FPO optimization endpoint + 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 FPO optimization endpoint + Run Pub calculation endpoint type: string style: simple responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once optimization is completed, returns 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 - "202": - description: Expected response returned if the optimization 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 @@ -16964,8 +16598,8 @@ 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: 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. @@ -17059,7 +16693,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. @@ -17096,40 +16730,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get FPO optimization status by id + summary: Cancel Pub calculation by id tags: - - FPO Optimizer - x-are-multiple-success-responses-different: true + - PubCalculations + 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/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 + 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 FPO optimization - 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 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 Pub calculation endpoint type: string style: simple responses: @@ -17137,8 +16758,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once optimization is completed, returns JSON. + $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 @@ -17245,8 +16866,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: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17377,26 +16997,66 @@ paths: available after successful authentication. type: string style: simple - summary: Get FPO optimization result by id + summary: Get Pub calculation parameters by id tags: - - FPO Optimizer + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ObjectRoot + response-type: PubCalculationParametersRoot 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 + 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 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: "200": content: application/json: schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of PA frequencies. + $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. @@ -17414,6 +17074,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 @@ -17432,8 +17106,19 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "201": + content: + application/pdf: + 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17451,23 +17136,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: @@ -17488,9 +17168,20 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json. + "202": + content: + application/json: + 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 @@ -17507,6 +17198,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 @@ -17525,9 +17230,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 Calculation Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17545,72 +17253,40 @@ 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-Calculations-Limit: + description: Maximum FI request limit. explode: false schema: + description: Maximum FI request limit. 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-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. explode: false schema: - description: FactSet's request key header. + description: Number of FI requests remaining till request limit reached. 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-Limit: + description: Number of allowed requests 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 - "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 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/spar/v3/frequencies: - get: - description: This endpoint lists all the frequencies that can be applied to - a SPAR calculation. - operationId: getSPARFrequencies - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of SPAR frequencies. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17628,26 +17304,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. @@ -17665,23 +17337,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: @@ -17702,8 +17369,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 calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17721,6 +17392,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 @@ -17739,9 +17424,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. + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Duplicate calculation exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17759,72 +17447,41 @@ 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-Calculations-Limit: + description: Maximum FI request limit. explode: false schema: + description: Maximum FI request limit. 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-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. explode: false schema: - description: FactSet's request key header. + description: Number of FI requests remaining till request limit reached. 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-Limit: + description: Number of allowed requests 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 - "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 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": - content: - application/json: - schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of Vault frequencies. + "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. @@ -17842,6 +17499,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 @@ -17860,8 +17531,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -17879,23 +17551,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: @@ -17916,8 +17583,16 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept 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. @@ -17935,27 +17610,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 - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17973,73 +17643,84 @@ 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-Calculations-Limit: + description: Maximum FI request limit. explode: false schema: + description: Maximum FI request limit. 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-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. explode: false schema: - description: FactSet's request key header. + description: Number of FI requests remaining till request limit reached. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + summary: Create or Update Pub calculation and run it. + tags: + - PubCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "201" + is-file: true + - status-code: "202" + response-type: CalculationStatusRoot + x-contentType: application/json + x-accepts: application/json + /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. explode: false schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. 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. + 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 - 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. explode: false @@ -18056,15 +17737,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 @@ -18083,28 +17755,29 @@ 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. 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 @@ -18139,8 +17812,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. @@ -18176,9 +17853,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. @@ -18196,35 +17877,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. @@ -18242,26 +17914,8 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA groups - tags: - - Groups - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: GroupRoot - x-accepts: application/json - /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: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of PA grouping frequencies + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18297,8 +17951,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. @@ -18316,8 +17971,8 @@ 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. @@ -18335,15 +17990,109 @@ 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 + summary: Get Pub calculation status 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 + 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 + parameters: + - 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 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: + "200": + content: + application/pdf: + schema: + format: binary + type: string + application/vnd.openxmlformats-officedocument.presentationml.presentation: + 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 + 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 @@ -18353,8 +18102,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. @@ -18390,9 +18143,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. @@ -18410,9 +18162,81 @@ 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 + "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. + 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 @@ -18456,56 +18280,35 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA grouping frequencies + summary: Get Pub calculation result by id tags: - - Groups + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FrequencyRoot + is-file: true x-accepts: application/json - /analytics/engines/pa/v3/linked-templates: + /analytics/engines/quant/v3/calculations: get: - description: This endpoint returns the list of linked PA templates in given - path. - operationId: getLinkedPATemplates + description: This endpoints returns all calculation requests. + operationId: getAllCalculations parameters: - - description: Get linked PA templates in path. - explode: true - in: query - name: directory - required: false - schema: - description: Get linked PA templates in path. - example: Personal:LinkedPATemplates/ - 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 + - explode: true in: query - name: documentName + name: pageNumber required: false schema: - description: Get linked PA templates for documents by document name - type: string + default: 1 + format: int32 + type: integer style: form 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/CalculationsSummaryRoot' + description: List of calculation requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18546,8 +18349,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + description: Invalid page number. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18588,7 +18390,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Document not found + description: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18644,7 +18446,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. @@ -18783,47 +18585,146 @@ paths: available after successful authentication. type: string style: simple - summary: Get linked PA templates + summary: Get all calculations tags: - - LinkedPATemplates + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: LinkedPATemplateSummaryRoot + response-type: CalculationsSummaryRoot 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 + 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: Standard HTTP header. Accepts no-store, max-age, max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkedPATemplateParametersRoot' - description: Request Parameters - required: true + $ref: '#/components/schemas/QuantCalculationParametersRoot' responses: - "201": + "202": content: application/json: schema: - $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' - description: Expected response, created a template linked to a PA3 tile. + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + Location: + description: URL to poll for the resulting calculation explode: false schema: - description: FactSet's request key header. + 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 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. + 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 + "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 + schema: + description: FactSet's request key header. type: string style: simple X-FactSet-Api-Request-Key: @@ -18858,8 +18759,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18895,8 +18798,15 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -18914,8 +18824,33 @@ 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 + "413": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Request body too large headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18951,8 +18886,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. @@ -18988,8 +18942,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. @@ -19026,8 +18981,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. @@ -19045,6 +19000,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. @@ -19091,33 +19064,38 @@ paths: available after successful authentication. type: string style: simple - summary: Create a linked PA template + summary: Create and Run Quant Engine calculation tags: - - LinkedPATemplates - 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: "201" - response-type: LinkedPATemplatePostSummaryRoot + response-type: ObjectRoot + - status-code: "200" + response-type: CalculationStatusRoot x-contentType: application/json x-accepts: application/json - /analytics/engines/pa/v3/linked-templates/{id}: + /analytics/engines/quant/v3/calculations/{id}: delete: - description: This endpoint deletes an existing linked PA template. - operationId: deleteLinkedPATemplates + description: This is the endpoint to cancel a previously submitted calculation. + operationId: cancelCalculationById parameters: - - description: Unique identifier for a linked PA template + - description: from url, provided from the location header in the Create and + Run Quant calculation endpoint explode: false in: path name: id required: true schema: - description: Unique identifier for a linked PA template - example: "01234567890123456789012345678901" + description: from url, provided from the location header in the Create and + Run Quant calculation endpoint type: string style: simple responses: "204": - description: Expected response, deleted the linked PA template successfully. + description: Expected response, calculation was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19155,17 +19133,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 data provided. Please check the request parameters - before attempting again. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19203,16 +19174,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: Template not found. + 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. @@ -19304,8 +19270,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json. + "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. @@ -19323,27 +19290,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. Wait till the time specified in Retry-After - header value to make further requests. + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19361,71 +19309,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. - 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: Delete a linked PA template. + summary: Cancel Quant calculation by id tags: - - LinkedPATemplates + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "204" x-accepts: application/json get: - description: This endpoint fetches the linked PA template settings. - operationId: getLinkedPATemplatesById + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters parameters: - - description: Unique identifier for a linked PA template + - 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: Unique identifier for a linked PA template - example: "01234567890123456789012345678901" + description: from url, provided from the location header in the Create and + Run Quant Engine calculation endpoint type: string style: simple responses: @@ -19433,9 +19337,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LinkedPATemplateRoot' - description: Expected response, linked PA template details. + $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 + 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 @@ -19475,8 +19404,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19517,7 +19445,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Template not found. + description: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19609,73 +19537,9 @@ 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. @@ -19712,52 +19576,63 @@ paths: available after successful authentication. type: string style: simple - summary: Get linked PA template by id + summary: Get Quant Engine calculation parameters by id tags: - - LinkedPATemplates + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: LinkedPATemplateRoot + response-type: QuantCalculationParametersRoot 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 + 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: Unique identifier for a linked PA template + - 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: Unique identifier for a linked PA template - example: "01234567890123456789012345678901" + 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 + name: Cache-Control + required: false + schema: type: string style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/LinkedPATemplateUpdateParametersRoot' - description: Request Parameters - required: true + $ref: '#/components/schemas/QuantCalculationParametersRoot' + description: Calculation Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' - description: Expected response, updated a template linked to a PA3 tile. + $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 @@ -19792,13 +19667,16 @@ paths: schema: type: string style: simple - "400": + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + $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. @@ -19834,12 +19712,17 @@ paths: schema: type: string style: simple - "404": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Template or component not found. + $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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19875,27 +19758,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. @@ -19931,8 +19802,15 @@ 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' + 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. @@ -19968,9 +19846,15 @@ 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. + "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. @@ -19988,108 +19872,34 @@ 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. - 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: 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. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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": + "413": 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 + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: schema: - description: URL to poll for the resulting optimization - type: string - style: simple + $ref: '#/components/schemas/ClientErrorResponse' + description: Request body too large + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -20124,13 +19934,27 @@ paths: schema: type: string style: simple - "201": - 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/ObjectRoot' - description: Expected response, returns json if optimization is completed - in a short span. + 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. @@ -20166,12 +19990,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid optimization parameters. + "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. @@ -20207,12 +20028,9 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + "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. @@ -20248,8 +20066,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + 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. @@ -20267,8 +20093,8 @@ 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. @@ -20286,28 +20112,72 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + summary: Create or update Quant Engine calculation and run it. + 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 + 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 + 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 + 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 - 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 - "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 @@ -20342,10 +20212,30 @@ paths: 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. + "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-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 @@ -20380,129 +20270,12 @@ 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 + "400": + content: + application/json: 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 NPO optimization - 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}: - 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 - 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: - "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. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20540,17 +20313,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 optimization 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. @@ -20644,7 +20411,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. @@ -20681,27 +20448,43 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel NPO optimization by id + summary: Get Quant Engine calculation status by id tags: - - NPO Optimizer + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - 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 that returns the optimization parameters passed - for an optimization. - operationId: getOptimizationParameters + 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 Create and - Run NPO optimization endpoint + - 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 Create and - Run NPO optimization endpoint + 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: @@ -20709,8 +20492,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Expected response, returns the NPO optimization parameters. + 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 @@ -20776,6 +20569,12 @@ 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: @@ -20817,7 +20616,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Optimization id not found + 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. @@ -20948,112 +20754,84 @@ paths: available after successful authentication. type: string style: simple - summary: Get NPO optimization parameters by id + summary: Get Quant Engine calculation result by id tags: - - NPO Optimizer + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: NPOOptimizationParametersRoot + is-file: true 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 + /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 NPO optimization 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 NPO optimization endpoint + description: from url, provided from the location header in the Get Quant + calculation status by id endpoint type: string style: simple - - description: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Get Quant + calculation status by id endpoint explode: false - in: header - name: Cache-Control - required: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Optimization Parameters responses: - "202": + "200": 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 + format: binary type: string - style: simple - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false + application/x-protobuf: schema: - description: FactSet's request key header. + format: binary 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 + application/octet-stream: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + format: binary type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + 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 - 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 - "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 @@ -21093,7 +20871,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Optimization Parameters. + 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. @@ -21134,7 +20918,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + 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. @@ -21170,12 +20961,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' - description: Duplicate optimization exists with same parameters. + 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. @@ -21211,8 +21017,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. @@ -21230,8 +21037,8 @@ 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. @@ -21249,27 +21056,35 @@ 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 + 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: false + schema: + default: 1 + format: int32 + type: integer + style: form + responses: + "200": + content: + application/json: schema: - type: string - style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + $ref: '#/components/schemas/CalculationsSummaryRoot' + description: List of calculation requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21305,9 +21120,12 @@ paths: 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. + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid page number. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21343,16 +21161,12 @@ 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: + application/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: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21370,8 +21184,26 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -21389,44 +21221,8 @@ paths: available after successful authentication. type: string style: simple - 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/ObjectRoot' - description: Expected response once optimization is completed, returns JSON. + "403": + description: User is forbidden with current credentials. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21462,26 +21258,9 @@ 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. 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 @@ -21516,12 +21295,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "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. @@ -21539,31 +21315,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' - description: Optimization result was already returned, provided id was not - a requested optimization, or the optimization was cancelled + "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. @@ -21581,26 +21342,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 - "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. @@ -21618,9 +21361,64 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + summary: Get all calculations + tags: + - SPARCalculations + 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 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 + parameters: + - description: Long running deadline in seconds when only one unit is passed + in the POST body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/SPARCalculationParametersRoot' + 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 @@ -21655,28 +21453,16 @@ 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 + "200": + 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/CalculationStatusRoot' + 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/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. @@ -21694,65 +21480,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get NPO optimization status by id - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "201" - response-type: ObjectRoot - - status-code: "202" - 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 - parameters: - - 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 Get NPO - optimization status by id endpoint - type: string - style: simple - responses: - "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. + 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 + "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. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -21792,7 +21549,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21833,8 +21593,10 @@ 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 + 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. @@ -21926,9 +21688,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. @@ -21946,8 +21708,27 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -21965,35 +21746,34 @@ paths: available after successful authentication. type: string style: simple - summary: Get NPO optimization result by id - tags: - - NPO Optimizer - 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/calculations: - get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations - parameters: - - explode: true - in: query - name: pageNumber - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - responses: - "200": - content: - application/json: + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false schema: - $ref: '#/components/schemas/CalculationsSummaryRoot' - description: List of calculation requests. + 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. @@ -22011,30 +21791,57 @@ 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": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. + summary: Create and Run SPAR calculation + tags: + - SPARCalculations + 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/spar/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 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 + responses: + "204": + description: Expected response, calculation was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22070,12 +21877,12 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation found. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22111,27 +21918,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 + "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: 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. @@ -22167,8 +21960,8 @@ 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. @@ -22186,27 +21979,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. Wait till the time specified in Retry-After - header value to make further requests. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22224,9 +21998,20 @@ 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 @@ -22270,77 +22055,60 @@ paths: available after successful authentication. type: string style: simple - summary: Get all calculations + summary: Cancel SPAR calculation tags: - - PACalculations + - SPARCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: CalculationsSummaryRoot + - status-code: "204" 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* Account identifiers\ - \ must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be\ - \ optionally set for every account. \r\n Possible values for holdings mode\ - \ are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management\ - \ System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default\ - \ holdings mode value is B&H. \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 grouping frequency without overriding the group id it will\ - \ not be applied to the default groupings saved to the original component.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component." - operationId: postAndCalculate + get: + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Create and + Run SPAR 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 SPAR calculation endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - 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. + $ref: '#/components/schemas/SPARCalculationParametersRoot' + description: Expected response, returns the SPAR calculation parameters. 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: @@ -22377,17 +22145,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. @@ -22423,16 +22186,12 @@ paths: schema: type: string style: simple - "200": + "404": 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. + $ref: '#/components/schemas/ClientErrorResponse' + description: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22468,15 +22227,8 @@ 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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22494,33 +22246,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' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22556,8 +22283,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. @@ -22575,8 +22303,8 @@ 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. @@ -22594,28 +22322,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 + summary: Get SPAR calculation parameters by id + tags: + - SPARCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: SPARCalculationParametersRoot + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/SPARCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + 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/CalculationStatusRoot' + 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/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 - "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 @@ -22650,9 +22426,16 @@ 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. + "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. @@ -22688,16 +22471,17 @@ 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 + "201": + content: + application/json: schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + $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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22715,57 +22499,33 @@ 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: 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. + 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. @@ -22801,18 +22561,15 @@ paths: schema: type: string style: simple - "400": + "404": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + 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. @@ -22848,19 +22605,15 @@ paths: schema: type: string style: simple - "404": + "409": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: 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: Duplicate calculation exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22952,9 +22705,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. @@ -22972,11 +22725,94 @@ 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: + 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. + 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. @@ -22991,27 +22827,35 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel PA calculation by id + summary: Create or Update SPAR calculation and run it. tags: - - PACalculations - x-are-multiple-success-responses-different: false + - SPARCalculations + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "204" + - 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/spar/v3/calculations/{id}/status: get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + 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 PA calculation endpoint + 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 PA calculation endpoint + Run SPAR calculation endpoint type: string style: simple responses: @@ -23019,8 +22863,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - description: Expected response, returns the PA calculation parameters. + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response once calculation is completed. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding @@ -23081,6 +22925,63 @@ paths: schema: 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. + 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: application/json: @@ -23127,7 +23028,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + 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. @@ -23258,89 +23160,80 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA calculation parameters by id + summary: Get SPAR calculation status by id tags: - - PACalculations + - SPARCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: PACalculationParametersRoot + response-type: CalculationStatusRoot + - status-code: "202" + response-type: CalculationStatusRoot 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* Account identifiers\ - \ must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be\ - \ optionally set for every account. \r\n Possible values for holdings mode\ - \ are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management\ - \ System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default\ - \ holdings mode value is B&H.\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 grouping frequency without overriding the group id it will\ - \ not be applied to the default groupings saved to the original component.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component." - operationId: putAndCalculate + /analytics/engines/spar/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 Create and - Run PA calculation endpoint + - 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 Create and - Run PA calculation endpoint + description: from url, provided from the location header in the Get SPAR + calculation status by id endpoint type: string style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Get SPAR calculation + status by id endpoint explode: false - in: header - name: Cache-Control - required: false + in: path + name: unitId + required: true schema: + description: from url, provided from the location header in the Get SPAR + calculation status by id endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - description: Calculation Parameters responses: - "202": + "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' + $ref: '#/components/schemas/ObjectRoot' application/x-protobuf: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once calculation is completed, returns JSON + in the format specified in the Calculation parameters. 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: @@ -23377,17 +23270,16 @@ paths: schema: type: string style: simple - "200": + "400": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' + $ref: '#/components/schemas/ClientErrorResponse' application/x-protobuf: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. - headers: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -23422,17 +23314,16 @@ paths: schema: type: string style: simple - "201": + "404": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' + $ref: '#/components/schemas/ClientErrorResponse' 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: 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. @@ -23468,15 +23359,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' - 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: Invalid Calculation 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. @@ -23512,15 +23415,79 @@ paths: schema: type: string style: simple - "404": + "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 calculation result by id + tags: + - SPARCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + x-accepts: application/json + /analytics/engines/axp/v3/strategies/{path}: + get: + description: This endpoint looks up all Axioma Equity strategy documents and + sub-directories in a given directory. + operationId: getAxiomaEquityStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma Equity strategy + documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23556,15 +23523,53 @@ paths: schema: type: string style: simple - "409": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + 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: Duplicate calculation exists with same parameters. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23601,7 +23606,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. @@ -23656,9 +23661,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. @@ -23695,8 +23699,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. @@ -23714,24 +23718,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. @@ -23741,7 +23727,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. @@ -23760,7 +23746,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. @@ -23778,37 +23764,30 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update PA calculation and run it. + summary: Get Axioma Equity strategy documents and sub-directories in a directory tags: - - PACalculations - x-are-multiple-success-responses-different: true + - StrategyDocuments + 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 + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/status: + /analytics/engines/afi/v3/strategies/{path}: 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 endpoint looks up all Axioma FI strategy documents and sub-directories + in a given directory. + operationId: getAxiomaFIStrategyDocuments parameters: - - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + - description: The directory to get the strategy documents and sub-directories + in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' type: string style: simple responses: @@ -23816,34 +23795,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response once calculation is completed. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma FI strategy documents + and directories 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 @@ -23878,30 +23833,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 query parameter or value 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 @@ -23936,12 +23874,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23977,13 +23915,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. @@ -24019,8 +23971,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. @@ -24038,8 +23990,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. @@ -24057,20 +24028,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 @@ -24096,7 +24056,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. @@ -24114,43 +24074,30 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA calculation status by id + summary: Get Axioma FI strategy documents and sub-directories in a directory tags: - - PACalculations + - StrategyDocuments 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: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/bpm/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 Barra strategy documents and sub-directories + in a given directory. + operationId: getBarraStrategyDocuments 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 + - 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 PA calculation - status by id endpoint + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' type: string style: simple responses: @@ -24158,38 +24105,10 @@ 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 Barra strategy documents + and directories 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 @@ -24229,10 +24148,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24273,11 +24189,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: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24314,7 +24226,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. @@ -24369,9 +24281,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "406": + description: Unsupported Accept header. Header needs to be set to application/json headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24389,8 +24300,27 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -24408,57 +24338,16 @@ paths: 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: + 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/PAPricingSourceRoot' - description: Expected response, returns a list of PA pricing sources + 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. @@ -24476,17 +24365,78 @@ 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. + "503": + description: Request timed out. Retry the request in some time + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: Standard HTTP header. Header will specify the age of - pricing sources list cached response. - type: integer + description: FactSet's request key header. + type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests 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 + summary: Get Barra 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/npo/v3/strategies/{path}: + get: + description: This endpoint looks up all Northfield strategy documents and sub-directories + in a given directory. + operationId: getNorthfieldStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Northfield strategy 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 @@ -24508,8 +24458,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24550,7 +24499,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Pricing sources not found. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24587,7 +24536,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. @@ -24643,7 +24592,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. @@ -24727,7 +24676,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. @@ -24745,35 +24694,48 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA pricing sources + summary: Get Northfield strategy documents and sub-directories in a directory tags: - - PricingSources + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: PAPricingSourceRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pub/v3/calculations: - get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations + /analytics/engines/vault/v3/load/{batchId}: + post: + description: This endpoint loads Vault External Attributions. + operationId: vaultAttributionLoader parameters: - - explode: true - in: query - name: pageNumber - required: false + - explode: false + in: path + name: batchId + required: true schema: - default: 1 - format: int32 - type: integer - style: form + 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/CalculationsSummaryRoot' - description: List of calculation requests. + $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. @@ -24814,48 +24776,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. - 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: No calculation found. + description: Bad Request headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24911,7 +24832,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. @@ -25050,62 +24971,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get all calculations + summary: Vault - External Attribution Loader tags: - - PubCalculations + - Vault Attribution Loader x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CalculationsSummaryRoot + response-type: VaultAttributionLoaderResponseRoot + x-contentType: multipart/form-data 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 + /analytics/engines/vault/v3/calculations: + get: + description: This endpoints returns all calculation requests. + operationId: getAllCalculations parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline + - explode: true + in: query + name: pageNumber required: false schema: - example: 10 + default: 1 + format: int32 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 + style: form responses: - "202": + "200": content: - application/pdf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/CalculationsSummaryRoot' + description: List of calculation requests. 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 @@ -25140,16 +25036,12 @@ paths: schema: type: string style: simple - "200": + "400": content: - application/pdf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid page number. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25185,19 +25077,12 @@ paths: schema: type: string style: simple - "201": + "404": 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/ClientErrorResponse' + description: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25233,15 +25118,27 @@ paths: schema: type: string style: simple - "400": - content: - application/pdf: + "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/vnd.openxmlformats-officedocument.presentationml.presentation: + 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: Invalid calculation 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. @@ -25277,19 +25174,12 @@ paths: schema: type: string style: simple - "404": - content: - 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: - description: FactSet's request key header. - explode: false + "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 @@ -25321,8 +25211,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. @@ -25340,8 +25231,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. @@ -25359,27 +25258,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 - "415": - description: Missing/Invalid Content-Type 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. @@ -25397,28 +25277,64 @@ 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 all calculations + tags: + - VaultCalculations + 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 Vault 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* Start and and end date must be within the configuration's min and\ + \ max date range" + operationId: postAndCalculate + parameters: + - description: Long running deadline in seconds when only one unit is passed + in the POST body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/VaultCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + 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/CalculationStatusRoot' + 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/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 - "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 @@ -25453,16 +25369,16 @@ 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 + "200": + content: + application/json: schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + $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. @@ -25480,57 +25396,35 @@ 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: 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. + 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 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. @@ -25568,16 +25462,13 @@ paths: style: simple "400": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25615,17 +25506,13 @@ paths: style: simple "404": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: 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: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25717,9 +25604,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. @@ -25737,8 +25624,27 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -25756,62 +25662,103 @@ paths: 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: + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Expected response, returns the Pub calculation parameters. + 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: - 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. + "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: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + 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 Vault calculation + tags: + - VaultCalculations + 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/vault/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 Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault 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 @@ -25892,7 +25839,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + 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. @@ -25986,7 +25934,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. @@ -26023,101 +25971,76 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation parameters by id + summary: Cancel Vault calculation by id tags: - - PubCalculations + - VaultCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: PubCalculationParametersRoot + - status-code: "204" 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 + 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 + Run Vault 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. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + Run Vault calculation endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Calculation Parameters responses: - "202": + "200": content: - application/pdf: + application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/VaultCalculationParametersRoot' + description: Expected response, returns the Vault calculation parameters. 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 - 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 - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + 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: @@ -26138,13 +26061,12 @@ paths: schema: type: string style: simple - "200": + "400": content: - application/pdf: + application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26162,20 +26084,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 @@ -26194,15 +26102,12 @@ paths: schema: type: string style: simple - "201": + "404": content: - application/pdf: + 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/ClientErrorResponse' + description: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26220,28 +26125,14 @@ 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. - 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. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. explode: false schema: type: string @@ -26252,12 +26143,8 @@ paths: schema: type: string style: simple - "400": - content: - application/pdf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26275,18 +26162,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: @@ -26307,12 +26199,9 @@ paths: schema: type: string style: simple - "404": - content: - application/pdf: - 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. @@ -26330,45 +26219,95 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + "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: 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: - description: Number of allowed requests for the time window. - explode: false + summary: Get Vault calculation parameters by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: VaultCalculationParametersRoot + x-accepts: application/json + put: + description: "This endpoint updates and run the Vault calculation specified\ + \ in the PUT body parameters. This also allows creating new Vault 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 Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + - description: Long running deadline in seconds when only one unit is passed + in the PUT body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/VaultCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + 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/CalculationStatusRoot' + 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/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 - "409": - content: - application/pdf: - 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 @@ -26385,20 +26324,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 @@ -26417,8 +26342,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -26436,22 +26369,35 @@ 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 + "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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26469,20 +26415,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 @@ -26501,9 +26433,15 @@ 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' + description: Invalid Calculation Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26521,20 +26459,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 @@ -26553,9 +26477,15 @@ 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' + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26573,18 +26503,48 @@ 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-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: @@ -26605,16 +26565,27 @@ 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 - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + 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. @@ -26632,22 +26603,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 - "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 + "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. @@ -26665,23 +26641,111 @@ 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 - summary: Create or Update Pub calculation and run it. + 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. + 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 or Update Vault calculation and run it. tags: - - PubCalculations + - VaultCalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" @@ -26689,10 +26753,10 @@ paths: - status-code: "200" response-type: CalculationStatusRoot - status-code: "201" - is-file: true + response-type: ObjectRoot x-contentType: application/json - x-accepts: application/pdf - /analytics/engines/pub/v3/calculations/{id}/status: + x-accepts: application/json + /analytics/engines/vault/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\ @@ -26700,14 +26764,14 @@ paths: operationId: getCalculationStatusById parameters: - description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run Vault 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 + Run Vault calculation endpoint type: string style: simple responses: @@ -27012,9 +27076,9 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation status by id + summary: Get Vault calculation status by id tags: - - PubCalculations + - VaultCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" @@ -27022,32 +27086,32 @@ paths: - status-code: "202" response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/vault/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." + \ response will contain the requested document in JSON." operationId: getCalculationUnitResultById 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 Get Vault + 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 Pub + description: from url, provided from the location header in the Get Vault 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 + - description: from url, provided from the location header in the Get Vault + 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 + description: from url, provided from the location header in the Get Vault calculation status by id endpoint type: string style: simple @@ -27056,17 +27120,11 @@ paths: content: application/json: schema: - format: binary - type: string + $ref: '#/components/schemas/ObjectRoot' application/x-protobuf: schema: - format: binary - type: string - application/pdf: - schema: - format: binary - type: string - description: Expected response once calculation is completed, returns result + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. headers: Content-Encoding: @@ -27136,9 +27194,6 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/pdf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. headers: X-DataDirect-Request-Key: @@ -27183,9 +27238,6 @@ paths: 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 headers: @@ -27318,15414 +27370,795 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation result by id + summary: Get Vault calculation result by id tags: - - PubCalculations + - VaultCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - is-file: true + response-type: ObjectRoot 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: false - 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. - 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 page number. - 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: No calculation 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 all calculations - tags: - - QuantCalculations - 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 Quant Engine calculation specified in the\ - \ POST body parameters.\r\nIt can take one or more calculation units as input." - operationId: postAndCalculate - parameters: - - description: Standard HTTP header. Accepts no-store, max-age, max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' - 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 - 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 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. - 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 - "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 - 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 - "413": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Request body too large - 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. - 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. - 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 Quant Engine calculation - tags: - - QuantCalculations - 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/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 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 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 Quant calculation by id - tags: - - QuantCalculations - 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 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 - responses: - "200": - content: - application/json: - schema: - $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 - 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 Quant Engine calculation parameters by id - tags: - - QuantCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: QuantCalculationParametersRoot - 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 - 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 - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' - 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 - 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 - "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 - 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 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. - 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 - "413": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Request body too large - 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. - 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. - 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 or update Quant Engine calculation and run it. - 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 - 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 - 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 - 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 - 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/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 - 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: - 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 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 - "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 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 - 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' - application/octet-stream: - 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' - 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. - 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 Quant Engine calculation result 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/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 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 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: - "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 - 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' - application/octet-stream: - 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' - 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. - 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 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: false - 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. - 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 page number. - 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: No calculation 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 all calculations - tags: - - SPARCalculations - 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 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 - parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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/SPARCalculationParametersRoot' - 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 - 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 - "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 - 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 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. - 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 - "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. - 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. - 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 SPAR calculation - tags: - - SPARCalculations - 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/spar/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 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 - 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 SPAR calculation - tags: - - SPARCalculations - 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 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 - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' - description: Expected response, returns the SPAR 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 SPAR calculation parameters by id - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: SPARCalculationParametersRoot - 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. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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/SPARCalculationParametersRoot' - 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 - 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 - "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 - 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 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. - 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. - 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. - 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 or Update SPAR calculation and run it. - tags: - - SPARCalculations - 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/spar/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 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 - 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 - 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/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. - 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: - 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 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 - "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 SPAR calculation status by id - tags: - - SPARCalculations - 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/spar/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 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 - explode: false - in: path - name: unitId - required: true - schema: - description: from url, provided from the location header in the Get SPAR - 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. - 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' - application/x-protobuf: - 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' - 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. - 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 SPAR calculation result by id - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - x-accepts: application/json - /analytics/engines/axp/v3/strategies/{path}: - get: - description: This endpoint looks up all Axioma Equity strategy documents and - sub-directories in a given directory. - operationId: getAxiomaEquityStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma Equity strategy - 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 - 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 some time - 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 Axioma Equity 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/afi/v3/strategies/{path}: - get: - 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 - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma FI strategy 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 - 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 some time - 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 Axioma FI 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/bpm/v3/strategies/{path}: - get: - description: This endpoint looks up all Barra strategy documents and sub-directories - in a given directory. - operationId: getBarraStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Barra strategy 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 - 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 some time - 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 Barra 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/npo/v3/strategies/{path}: - get: - description: This endpoint looks up all Northfield strategy documents and sub-directories - in a given directory. - operationId: getNorthfieldStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Northfield strategy 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 - 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 some time - 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 Northfield 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/fpo/v3/strategies/{path}: - get: - 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 - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - 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. - 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 - 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 some time - 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 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 - example: Personal:TemplatedPAComponents/ - type: string - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' - description: Expected response, returns a list templated PA components. - 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 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 - "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 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* Account identifiers must have .ACCT or .ACTM extension\ - \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ - \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ - \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ - \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ - \n* Multi-horizon frequencies are not supported through this endpoint.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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. - 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 - "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: 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 - "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: Create 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 - x-accepts: application/json - /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: - "204": - description: Expected response, deleted the templated PA component 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": - 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. - 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: Delete templated PA component - tags: - - TemplatedPAComponents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "204" - x-accepts: application/json - get: - description: This endpoint fetches the templated PA component settings. - operationId: getTemplatedPAComponentById - 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: - "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. - 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 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: Templated PA component 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 templated PA component by id - tags: - - TemplatedPAComponents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: TemplatedPAComponentRoot - 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* Account identifiers must have .ACCT or .ACTM\ - \ extension or BENCH: prefix. Holdings mode can be optionally set for every\ - \ account. \r\n Possible values for holdings mode are B&H (Buy and Hold),\ - \ TBR (Transaction based returns), OMS (Order Management System), \r\n \ - \ VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode\ - \ value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through\ - \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall,\ - \ and totals levels of granularity. However, if no value is passed, the default\ - \ value is 'securities'.\r\n Additionally, while 'groupsall' returns all\ - \ the group levels in the PA component,\r\n setting componentdetail to\ - \ 'groups' only returns the expanded or collapsed group levels within the\ - \ PA component.\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 grouping\ - \ 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 - in: path - name: id - 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/TemplatedPAComponentPostSummaryRoot' - description: Expected response, updated 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: - 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: 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: - 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: Update templated PA component - tags: - - TemplatedPAComponents - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: TemplatedPAComponentPostSummaryRoot - x-contentType: application/json - 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. - example: Personal:UninkedPATemplates/ - 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. - example: Weights - type: string - style: form - responses: - "200": - content: - application/json: - schema: - $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. - 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 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 - "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 unlinked PA templates - tags: - - UnlinkedPATemplates - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: UnlinkedPATemplateSummaryRoot - 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* Account identifiers must have .ACCT\ - \ or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set\ - \ for every account. \r\n Possible values for holdings mode are B&H (Buy\ - \ and Hold), TBR (Transaction based returns), OMS (Order Management System),\ - \ \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings\ - \ mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported\ - \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ - \ groupsall, and totals levels of granularity. However, if no value is passed,\ - \ the default value is 'securities'.\r\n Additionally, while 'groupsall'\ - \ returns all the group levels in the PA component,\r\n setting componentdetail\ - \ to 'groups' only returns the expanded or collapsed group levels within the\ - \ PA component.\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 grouping\ - \ 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: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, created a unlinked PA template. - 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 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 - "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: Create 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 - x-accepts: application/json - /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: - "204": - description: Expected response, deleted the unlinked 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: - 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: 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: - 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: Delete unlinked PA template - tags: - - UnlinkedPATemplates - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "204" - x-accepts: application/json - get: - description: This endpoint fetches the template settings. - operationId: getUnlinkedPATemplatesById - 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: - "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. - 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 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: 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: - 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 unlinked PA template details by id - tags: - - UnlinkedPATemplates - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: UnlinkedPATemplateRoot - 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* Account identifiers must have .ACCT or .ACTM extension\ - \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ - \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ - \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ - \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ - \n* Multi-horizon frequencies are not supported through this endpoint.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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 - 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/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, updated the unlinked PA template. - 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 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: 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: - 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: 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": - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' - description: Expected response, default unlinked PA template types - 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 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. - 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 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. - 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 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: UnlinkedPATemplateCategoryAndTypeDetailsRoot - x-accepts: application/json - /analytics/engines/vault/v3/calculations: - get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations - parameters: - - explode: true - in: query - name: pageNumber - required: false - 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. - 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 page number. - 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: No calculation 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 all calculations - tags: - - VaultCalculations - 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 Vault 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* Start and and end date must be within the configuration's min and\ - \ max date range" - operationId: postAndCalculate - parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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/VaultCalculationParametersRoot' - 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 - 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 - "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 - 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 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. - 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 - "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. - 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. - 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 Vault calculation - tags: - - VaultCalculations - 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/vault/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 Vault calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run Vault 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 Vault calculation by id - tags: - - VaultCalculations - 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 Vault calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Expected response, returns the Vault 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 Vault calculation parameters by id - tags: - - VaultCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: VaultCalculationParametersRoot - x-accepts: application/json - put: - description: "This endpoint updates and run the Vault calculation specified\ - \ in the PUT body parameters. This also allows creating new Vault 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 Create and - Run Vault calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint - type: string - style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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/VaultCalculationParametersRoot' - 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 - 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 - "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 - 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 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. - 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. - 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. - 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 or Update Vault calculation and run it. - tags: - - VaultCalculations - 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/vault/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 Vault calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run Vault 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 - 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/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. - 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: - 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 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 - "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 Vault calculation status by id - tags: - - VaultCalculations - 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/vault/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 Vault - 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 Vault - calculation status by id endpoint - type: string - style: simple - - description: from url, provided from the location header in the Get Vault - 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 Vault - 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. - 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' - application/x-protobuf: - 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' - 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. - 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 Vault calculation result by id - tags: - - VaultCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - x-accepts: application/json -components: - schemas: - ReturnType: - example: - name: name - id: id - properties: - name: - type: string - id: - type: string - type: object - SPARAccounts: - example: - returnsType: - - name: name - id: id - - name: name - id: id - properties: - returnsType: - description: List of SPAR returnsType - items: - $ref: '#/components/schemas/ReturnType' - type: array - type: object - SPARAccountsRoot: - example: - data: - returnsType: - - name: name - id: id - - name: name - id: id - meta: '{}' - properties: - data: - $ref: '#/components/schemas/SPARAccounts' - meta: - type: object - required: - - data - type: object - ErrorSource: - example: - pointer: pointer - parameter: parameter - properties: - pointer: - type: string - parameter: - type: string - type: object - Error: - example: - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - properties: - id: - type: string - code: - type: string - title: - type: string - detail: - type: string - source: - $ref: '#/components/schemas/ErrorSource' - type: object - ClientErrorResponse: - properties: - errors: - items: - $ref: '#/components/schemas/Error' - type: array - type: object - AccountDirectories: - 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: - example: - data: - directories: - - directories - - directories - accounts: - - accounts - - accounts - meta: '{}' - properties: - data: - $ref: '#/components/schemas/AccountDirectories' - meta: - type: object - required: - - data - type: object - AFIOptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - properties: - objective: - description: Objective - type: string - tax: - description: Tax - type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string - description: List of constraints - type: object - alpha: - description: Alpha - type: string - transactionCost: - description: Transaction cost - type: string - type: object - AFIOptimizerStrategy: - example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - properties: - overrides: - $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path - type: string - required: - - id - type: object - OptimizerAccountOverrides: - example: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - portfolio: - description: Portfolio - type: string - benchmark: - description: Benchmark - type: string - riskModelId: - description: Risk model - type: string - currency: - description: Currency - type: string - type: object - OptimizerAccount: - example: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - id: - description: Account path - type: string - overrides: - $ref: '#/components/schemas/OptimizerAccountOverrides' - type: object - Optimization: - example: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - properties: - riskModelDate: - description: Risk model date - type: string - backtestDate: - description: Backtest date - type: string - cashflow: - description: Cash flow - type: string - type: object - OptimizerTradesList: - example: - includeCash: true - identifierType: Asset - properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User - type: string - includeCash: - description: Include cash - type: boolean - type: object - OptimizerOptimalHoldings: - example: - includeCash: true - excludeZero: true - identifierType: Asset - properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User - type: string - includeCash: - description: Include cash - type: boolean - excludeZero: - description: Exclude zero - type: boolean - type: object - OptimalPortfolio: - example: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - properties: - acctName: - description: Account path - type: string - excludeZero: - description: Exclude zero - type: boolean - archiveDate: - description: Archive date - type: string - ifAcctExists: - description: Archive action if account exists - enum: - - abort - - overwrite - - appendDate - type: string - ifOfdbDateExists: - description: Action if ofdb date exists - enum: - - abort - - replaceDate - - appendSecurities - type: string - type: object - OptimizerStats: - type: object - OptimizerOutputTypes: - example: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - properties: - trades: - $ref: '#/components/schemas/OptimizerTradesList' - optimal: - $ref: '#/components/schemas/OptimizerOptimalHoldings' - account: - $ref: '#/components/schemas/OptimalPortfolio' - stats: - type: object - type: object - AFIOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/AFIOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - OptimizerCalculationMeta: - type: object - AFIOptimizationParametersRoot: - example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' - properties: - data: - $ref: '#/components/schemas/AFIOptimizationParameters' - meta: - type: object - type: object - CalculationInfo: - properties: - calculationId: - description: Calculation identifier - type: string - type: object - CalculationInfoRoot: - properties: - data: - $ref: '#/components/schemas/CalculationInfo' - meta: - type: object - required: - - data - type: object - ObjectRoot: - example: - data: '{}' - meta: '{}' - properties: - data: - type: object - meta: - type: object - required: - - data - type: object - AxiomaEquityOptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - properties: - objective: - description: Objective - type: string - tax: - description: Tax - type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string - description: List of constraints - type: object - alpha: - description: Alpha - type: string - transactionCost: - description: Transaction cost - type: string - type: object - AxiomaEquityOptimizerStrategy: - example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - properties: - overrides: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path - type: string - required: - - id - type: object - AxiomaEquityOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - AxiomaEquityOptimizationParametersRoot: - example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' - properties: - data: - $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' - meta: - type: object - type: object - SPARIdentifier: - 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: Account or benchmark return type. - type: string - prefix: - description: Account or benchmark prefix. - type: string - required: - - id - type: object - SPARBenchmark: - 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: - 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: - example: - item2: Disable - item1: item1 - properties: - item1: - type: string - item2: - enum: - - Disable - - Enable - type: string - type: object - BPMOptimizerStrategyAlphaOverride: - example: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - properties: - formula: - type: string - returnType: - enum: - - Excess - - Total - - Active - - Residual - - Exceptional - type: string - returnMultiplier: - type: string - type: object - BPMOptimizerStrategyOverrides: - example: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - properties: - constraints: - description: List of constraints - items: - $ref: '#/components/schemas/ConstraintAction' - type: array - alpha: - $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' - tax: - description: "Tax\r\nCan be set to \"\" for local" - type: string - transactionCost: - description: "Transaction cost\r\nCan be set to \"\" for local" - type: string - type: object - BPMOptimizerStrategy: - example: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id - properties: - overrides: - $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path - type: string - required: - - id - type: object - BPMOptimization: - example: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - properties: - market: - description: Optimization market - type: string - investAllCash: - description: Optimization invest all cash - type: boolean - riskModelDate: - description: Risk model date - type: string - backtestDate: - description: Backtest date - type: string - cashflow: - description: Cash flow - type: string - type: object - BPMOptimizationParameters: - example: - optimization: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/BPMOptimizerStrategy' - optimization: - $ref: '#/components/schemas/BPMOptimization' - account: - $ref: '#/components/schemas/OptimizerAccount' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - BPMOptimizationParametersRoot: - example: - data: - optimization: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' - properties: - data: - $ref: '#/components/schemas/BPMOptimizationParameters' - meta: - type: object - type: object - ColumnSummary: - description: Column settings (name, directory, category) - example: - name: name - category: category - directory: directory - properties: - name: - description: Column Name - type: string - directory: - description: Column Directory - type: string - category: - description: Column Category - type: string - type: object - ColumnSummaryRoot: - example: - data: - key: - name: name - category: category - directory: directory - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ColumnSummary' - type: object - meta: - type: object - required: - - data - type: object - Column: - example: - defaultstatisticsids: - - defaultstatisticsids - - defaultstatisticsids - name: name - category: category - directory: directory - properties: - defaultstatisticsids: - description: Column statistic Id - items: - type: string - type: array - name: - description: Column Name - type: string - directory: - description: Column Directory - type: string - category: - description: Column Category - type: string - type: object - ColumnRoot: - example: - data: - defaultstatisticsids: - - defaultstatisticsids - - defaultstatisticsids - name: name - category: category - directory: directory - meta: '{}' - properties: - data: - $ref: '#/components/schemas/Column' - meta: - type: object - required: - - data - type: object - ColumnStatistic: - example: - name: name - properties: - name: - description: Column Statistic Name - type: string - type: object - ColumnStatisticRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ColumnStatistic' - type: object - meta: - type: object - required: - - data - type: object - ComponentSummary: - example: - name: name - category: category - properties: - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - ComponentSummaryRoot: - example: - data: - key: - name: name - category: category - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ComponentSummary' - type: object - meta: - type: object - required: - - data - type: object - PAIdentifier: - example: - id: id - holdingsmode: holdingsmode - properties: - id: - description: User's FactSet account path OR benchmark. - type: string - holdingsmode: - description: Holdings Mode can be B&H, TBR, OMS , EXT or VLT. - type: string - required: - - id - type: object - PADateParameters: - description: The date parameters for PA calculation. - example: - enddate: enddate - startdate: startdate - frequency: frequency - properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. - type: string - required: - - enddate - - frequency - type: object - PAComponent: - example: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - category: category - snapshot: true - properties: - id: - description: Component identifier. - type: string - accounts: - description: List of accounts saved in the PA document. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks saved in the PA document. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - currencyisocode: - type: string - dates: - $ref: '#/components/schemas/PADateParameters' - snapshot: - description: Is the component type snapshot or subperiod. - type: boolean - path: - description: The path to the document - type: string - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - PAComponentRoot: - example: - data: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - category: category - snapshot: true - meta: '{}' - properties: - data: - $ref: '#/components/schemas/PAComponent' - meta: - type: object - required: - - data - type: object - SPARComponent: - example: - path: path - name: name - id: id - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmarks: - prefix: prefix - returntype: returntype - id: id - currencyIsoCode: currencyIsoCode - category: category - properties: - id: - description: Component identifier. - type: string - accounts: - description: List of accounts in SPAR document. - items: - $ref: '#/components/schemas/SPARIdentifier' - type: array - benchmarks: - $ref: '#/components/schemas/SPARIdentifier' - currencyIsoCode: - description: CurrencyCode in SPAR document. - type: string - path: - description: The path to the document - type: string - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - SPARComponentRoot: - example: - data: - path: path - name: name - id: id - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmarks: - prefix: prefix - returntype: returntype - id: id - currencyIsoCode: currencyIsoCode - category: category - properties: - data: - $ref: '#/components/schemas/SPARComponent' - type: object - VaultIdentifier: - description: The account/benchmark parameter for Vault calculation. - example: - id: id - properties: - id: - description: User's FactSet account path OR benchmark. - type: string - required: - - id - type: object - VaultDateParameters: - description: The date parameters for Vault calculation - example: - enddate: enddate - startdate: startdate - frequency: frequency - properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. - type: string - required: - - enddate - - frequency - type: object - VaultComponent: - example: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - category: category - account: - id: id - benchmark: - id: id - snapshot: true - properties: - id: - description: Vault component identifier - type: string - account: - $ref: '#/components/schemas/VaultIdentifier' - benchmark: - $ref: '#/components/schemas/VaultIdentifier' - currencyisocode: - description: Currency iso code saved in the document - type: string - dates: - $ref: '#/components/schemas/VaultDateParameters' - snapshot: - description: Snapshot - type: boolean - path: - description: The path to the document - type: string - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - VaultComponentRoot: - example: - data: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - category: category - account: - id: id - benchmark: - id: id - snapshot: true - meta: '{}' - properties: - data: - $ref: '#/components/schemas/VaultComponent' - meta: - type: object - required: - - data - type: object - VaultConfigurationSummary: - example: - name: name - properties: - name: - description: Configuration name. - type: string - type: object - VaultConfigurationSummaryRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/VaultConfigurationSummary' - type: object - meta: - type: object - required: - - data - type: object - ConfigurationAccount: - example: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName - properties: - benchmarkCode: - description: Benchmark code. - type: string - benchmarkName: - description: Benchmark name. - type: string - maxEndDate: - description: Maximum end date. - type: string - minStartDate: - description: Minimum start date. - type: string - lockingDate: - description: Locking date. - type: string - name: - description: Account name. - type: string - type: object - VaultConfiguration: - example: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName - properties: - name: - description: Configuration name. - type: string - accounts: - additionalProperties: - $ref: '#/components/schemas/ConfigurationAccount' - type: object - type: object - VaultConfigurationRoot: - example: - data: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName - meta: '{}' - properties: - data: - $ref: '#/components/schemas/VaultConfiguration' - meta: - type: object - required: - - data - type: object - Currency: - example: - name: name - properties: - name: - description: Name of currency. - type: string - type: object - CurrencyRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/Currency' - type: object - meta: - type: object - required: - - data - type: object - DateParametersSummary: - example: - enddate: enddate - startdate: startdate - properties: - startdate: - description: Start date in YYYYMMDD format. - type: string - enddate: - description: End date in YYYYMMDD format. - type: string - type: object - DateParametersSummaryRoot: - example: - data: - enddate: enddate - startdate: startdate - meta: '{}' - properties: - data: - $ref: '#/components/schemas/DateParametersSummary' - meta: - type: object - required: - - data - type: object - FIDiscountCurveInfo: - example: - name: name - currency: currency - category: category - properties: - category: - type: string - name: - type: string - currency: - type: string - type: object - FIDiscountCurveInfoRoot: - example: - data: - key: - name: name - currency: currency - category: category - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/FIDiscountCurveInfo' - type: object - meta: - type: object - required: - - data - type: object - DocumentDirectories: - example: - documents: - - documents - - documents - directories: - - directories - - directories - properties: - documents: - description: List of documents - items: - type: string - type: array - directories: - description: List of directories. - items: - type: string - type: array - type: object - DocumentDirectoriesRoot: - example: - data: - documents: - - documents - - documents - directories: - - directories - - directories - meta: '{}' - properties: - data: - $ref: '#/components/schemas/DocumentDirectories' - meta: - type: object - required: - - data - type: object - FIABIdentifier: - example: - id: id - properties: - id: - description: User's FactSet account path. - type: string - required: - - id - type: object - FIABDateParameters: - description: The date parameters for FIAB calculations. - example: - enddate: enddate - startdate: startdate - properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date. - type: string - required: - - enddate - - startdate - type: object - FIABCalculationParameters: - example: - fiabdocument: fiabdocument - msl: msl - dates: - enddate: enddate - startdate: startdate - fisettingsdocument: fisettingsdocument - account: - id: id - properties: - fiabdocument: - description: "FiabDocument (optional) - FIAB document to use as a template.\ - \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" - type: string - account: - $ref: '#/components/schemas/FIABIdentifier' - dates: - $ref: '#/components/schemas/FIABDateParameters' - msl: - description: Master FISecurity List. Analytics results will be written to - the selected MSL. Expects a GUI-style path (Client:/foo/bar) - type: string - fisettingsdocument: - description: "FISettingsDocument (optional) - The given @FIS document will\ - \ be used to\r\nconfigure analytics assumptions and settings. Expects\ - \ a GUI-style path (Client:/foo/bar)" - type: string - required: - - account - - dates - type: object - FIABCalculationStatusSummary: - properties: - requesttime: - description: Request time of calculation. - format: date-time - type: string - lastpolltime: - description: Last poll time of calculation. - format: date-time - type: string - type: object - EventSummary: +components: + requestBodies: + inline_object: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/inline_object' + schemas: + ReturnType: example: - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type + name: name + id: id properties: - message: - description: Event's message - type: string - submissiondatetime: - description: Event's submission time - format: date-time + name: type: string - type: - description: Event's type + id: type: string type: object - FIABCalculationStatus: + SPARAccounts: example: - completiondatetime: 2000-01-23T04:56:07.000+00:00 - batchevents: - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - progress: 0 - id: id - status: Pending - startdatetime: 2000-01-23T04:56:07.000+00:00 + returnsType: + - name: name + id: id + - name: name + id: id properties: - id: - description: Calculation's identifier - type: string - status: - description: Calculation's status - enum: - - Pending - - InProgress - - Done - - Paused - - Cancelled - - Error - type: string - startdatetime: - description: Start time - format: date-time - type: string - completiondatetime: - description: Completion time - format: date-time - type: string - progress: - description: Calculation's progress - format: int32 - type: integer - batchevents: - description: List of batch events + returnsType: + description: List of SPAR returnsType items: - $ref: '#/components/schemas/EventSummary' + $ref: '#/components/schemas/ReturnType' type: array type: object - FIReferencePrepay: + SPARAccountsRoot: example: - prepayName: prepayName + data: + returnsType: + - name: name + id: id + - name: name + id: id + meta: '{}' properties: - prepayName: - description: Reference Prepay Name - type: string + data: + $ref: '#/components/schemas/SPARAccounts' + meta: + type: object + required: + - data type: object - FIReferenceSecurity: + ErrorSource: example: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement + pointer: pointer + parameter: parameter properties: - securityType: - description: Reference Security Type - type: string - securityName: - description: Reference Security Name - type: string - calcFromMethod: - description: "Reference Calculation Method.\r\nMethods : Active Spread,\ - \ Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield\ - \ To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield\ - \ To Worst Call, Discount Yield, Discount Margin, Implied Volatility,\ - \ Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + pointer: type: string - calcFromValue: - description: Reference CalcFromValue - format: double - type: number - prepay: - $ref: '#/components/schemas/FIReferencePrepay' - settlement: - description: Reference Settlement Date + parameter: type: string type: object - FIBankLoans: - example: - ignoreSinkingFund: true - properties: - ignoreSinkingFund: - description: Ignore Sinking Fund - type: boolean - type: object - FIMunicipalBonds: - example: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - properties: - ignoreSinkingFund: - description: Ignore Sinking Fund Schedule - type: boolean - useAnticipatedSinkSchedule: - description: Anticipate Sink Schedule - type: boolean - type: object - FILoss: + Error: example: - lossName: lossName + code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title properties: - lossName: - description: Loss Name + id: type: string - type: object - FIPrepay: - example: - prepayName: prepayName - properties: - prepayName: - description: Prepay Name + code: type: string - type: object - FIServicerAdvancesForSecurities: - example: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - properties: - principal: - description: Principal - format: double - type: number - interest: - description: Interest - format: double - type: number - advanceType: - description: Advance Type - enum: - - Advances All - - Advances All But Newly Liqdtd - - Does Not Advance - - Principal Only - - Interest Only + title: + type: string + detail: type: string + source: + $ref: '#/components/schemas/ErrorSource' type: object - FIPrepayLockout: - example: - pointsAbove: ANY - ymAbove: ANY + ClientErrorResponse: properties: - pointsAbove: - description: Points Above - enum: - - ANY - - NO_LOCKOUT - - NUMERIC - type: string - ymAbove: - description: Ym Above - enum: - - ANY - - NO_LOCKOUT - - NUMERIC - type: string + errors: + items: + $ref: '#/components/schemas/Error' + type: array type: object - FICashflows: + AccountDirectories: + description: List of the accounts and directories. example: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + directories: + - directories + - directories + accounts: + - accounts + - accounts properties: - optionalRedemptionCallWhenUnits: - description: OptionalRedemptionCallWhenUnits - enum: - - Manual - - Never - - ASAP - - Date - - Deal Closing - - Settle Date - type: string - optionalRedemptionCallWhen: - description: OptionalRedemptionCallWhen - format: int32 - type: integer - recoveryLag: - description: RecoveryLag - format: int32 - type: integer + 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 - FIBalloonExtension: + AccountDirectoriesRoot: example: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 + data: + directories: + - directories + - directories + accounts: + - accounts + - accounts + meta: '{}' properties: - months: - description: Months - format: int32 - type: integer - percentage: - description: Percentage - format: double - type: number - amortizationType: - description: Amortization Type - enum: - - Loan_Amort_None - - Loan_Amort_Regular - - Loan_Amort_Default - type: string - units: - description: Units - type: string - couponStepup: - description: Coupon Stepup - format: double - type: number + data: + $ref: '#/components/schemas/AccountDirectories' + meta: + type: object + required: + - data type: object - FIStructuredProductsForSecurities: + AFIOptimizerStrategyOverrides: example: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective properties: - servicerAdvances: - $ref: '#/components/schemas/FIServicerAdvancesForSecurities' - ignoreFinancialGuarantee: - description: Ignore Financial Guarantee + objective: + description: Objective type: string - cleanUpCallMethod: - description: Cleanup Call Method - type: boolean - doOPTRedeem: - description: Do OPT Redeem + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost type: string - prepayLockout: - $ref: '#/components/schemas/FIPrepayLockout' - cashflows: - $ref: '#/components/schemas/FICashflows' - balloonExtension: - $ref: '#/components/schemas/FIBalloonExtension' type: object - FIAttributionForSecurities: + AFIOptimizerStrategy: example: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id properties: - startPrice: - description: Start Price - format: double - type: number - endPrice: - description: End Price - format: double - type: number - startSpread: - description: Start Spread - format: double - type: number - endSpread: - description: End Spread - format: double - type: number - pricingMethod: - description: Pricing Method - enum: - - Inputted Price - - Pricing Matrix - - Actual Spread - - OAS + overrides: + $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path type: string + required: + - id type: object - FISecurity: + OptimizerAccountOverrides: example: - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 1.4894159098541704 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 6.84685269835264 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: - settlement: - description: Settlement date - type: string - callMethod: - description: Call Method - enum: - - No Call - - Intrinsic Value - - First Call - - First Par - type: string - referenceSecurity: - $ref: '#/components/schemas/FIReferenceSecurity' - bankLoans: - $ref: '#/components/schemas/FIBankLoans' - municipalBonds: - $ref: '#/components/schemas/FIMunicipalBonds' - loss: - $ref: '#/components/schemas/FILoss' - prepay: - $ref: '#/components/schemas/FIPrepay' - matrixSpreadAdjustment: - description: Matrix Spread Adjustment - format: double - type: number - matrixMultiplier: - description: Matrix Multiplier - format: double - type: number - structuredProducts: - $ref: '#/components/schemas/FIStructuredProductsForSecurities' - attribution: - $ref: '#/components/schemas/FIAttributionForSecurities' - calcFromMethod: - description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ - \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ - \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ - \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ - \ To Worst Call, Pricing Matrix" + portfolio: + description: Portfolio type: string - calcFromValue: - description: Calculation from value - format: double - type: number - face: - default: 1 - description: Face - format: double - type: number - faceType: - default: Current - description: Face type - enum: - - Current - - Original + benchmark: + description: Benchmark type: string - symbol: - description: Symbol + riskModelId: + description: Risk model type: string - discountCurve: - description: Discount curve + currency: + description: Currency type: string - required: - - calcFromValue - - symbol type: object - FIMunicipalBondsForJobSettings: + OptimizerAccount: example: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: - allowSinkForInstallmentPayment: - description: Allow Sink For Installment Payment - type: boolean - ignoreSinkingFund: - description: Ignore Sinking Fund Schedule - type: boolean - useAnticipatedSinkSchedule: - description: Anticipate Sink Schedule - type: boolean + id: + description: Account path + type: string + overrides: + $ref: '#/components/schemas/OptimizerAccountOverrides' type: object - FIMarketEnvironment: + Optimization: example: - ratePath: FLAT & FORWARD + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate properties: - ratePath: - default: FLAT & FORWARD - description: Rate Path - enum: - - FLAT - - FORWARD - - FLAT & FORWARD + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow type: string type: object - FIServicerAdvances: + OptimizerTradesList: example: - advanceType: Advances All + includeCash: true + identifierType: Asset properties: - advanceType: - description: Advance Type + identifierType: + description: Identifier type enum: - - Advances All - - Advances All But Newly Liqdtd - - Does Not Advance - - Principal Only - - Interest Only + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User type: string + includeCash: + description: Include cash + type: boolean type: object - FIStructuredProductsForJobSettings: + OptimizerOptimalHoldings: example: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + includeCash: true + excludeZero: true + identifierType: Asset properties: - servicerAdvances: - $ref: '#/components/schemas/FIServicerAdvances' - ignoreFinancialGuarantee: - description: Ignore Financial Guarantee + identifierType: + description: Identifier type + enum: + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User type: string - cleanUpCallMethod: - description: Cleanup Call Method + includeCash: + description: Include cash + type: boolean + excludeZero: + description: Exclude zero type: boolean - doOPTRedeem: - description: Do OPT Redeem - type: string - prepayLockout: - $ref: '#/components/schemas/FIPrepayLockout' - cashflows: - $ref: '#/components/schemas/FICashflows' - balloonExtension: - $ref: '#/components/schemas/FIBalloonExtension' type: object - FIAttributionForJobSettings: + OptimalPortfolio: example: - endDate: endDate - startDate: startDate + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName properties: - startDate: - description: Start Date + acctName: + description: Account path type: string - endDate: - description: End Date + excludeZero: + description: Exclude zero + type: boolean + archiveDate: + description: Archive date + type: string + ifAcctExists: + description: Archive action if account exists + enum: + - abort + - overwrite + - appendDate + type: string + ifOfdbDateExists: + description: Action if ofdb date exists + enum: + - abort + - replaceDate + - appendSecurities type: string type: object - FIJobSettings: + OptimizerStats: + type: object + OptimizerOutputTypes: example: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 7 - - 7 - settlement: settlement + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + properties: + trades: + $ref: '#/components/schemas/OptimizerTradesList' + optimal: + $ref: '#/components/schemas/OptimizerOptimalHoldings' + account: + $ref: '#/components/schemas/OptimalPortfolio' + stats: + type: object + type: object + AFIOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: - asOfDate: - description: As of date - type: string - partialDurationMonths: - description: Partial duration months - items: - format: int32 - type: integer - type: array - callMethod: - description: Call Method - enum: - - No Call - - Intrinsic Value - - First Call - - First Par - type: string - settlement: - description: Settlement Date - type: string - calcFromMethod: - description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ - \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ - \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ - \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ - \ To Worst Call, Pricing Matrix" - type: string - bankLoans: - $ref: '#/components/schemas/FIBankLoans' - municipalBonds: - $ref: '#/components/schemas/FIMunicipalBondsForJobSettings' - marketEnvironment: - $ref: '#/components/schemas/FIMarketEnvironment' - structuredProducts: - $ref: '#/components/schemas/FIStructuredProductsForJobSettings' - attribution: - $ref: '#/components/schemas/FIAttributionForJobSettings' + strategy: + $ref: '#/components/schemas/AFIOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' required: - - asOfDate + - outputTypes + - strategy type: object - FICalculationParameters: + OptimizerCalculationMeta: + type: object + AFIOptimizationParametersRoot: example: - jobSettings: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 7 - - 7 - settlement: settlement - calculations: - - calculations - - calculations - securities: - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 1.4894159098541704 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 6.84685269835264 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 1.4894159098541704 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 6.84685269835264 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' properties: - securities: - description: List of securities - items: - $ref: '#/components/schemas/FISecurity' - type: array - calculations: - description: List of calculations - items: - type: string - type: array - jobSettings: - $ref: '#/components/schemas/FIJobSettings' - required: - - calculations - - jobSettings - - securities + data: + $ref: '#/components/schemas/AFIOptimizationParameters' + meta: + type: object type: object - CalculationMeta: - example: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + CalculationInfo: properties: - contentorganization: - default: SimplifiedRow - deprecated: true - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - stachContentOrganization: - default: SimplifiedRow - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - contenttype: - default: Json - deprecated: true - enum: - - Json - - Binary - type: string - format: - default: JsonStach - enum: - - JsonStach - - Table - - Tableau - - BinaryStach - - Bison - - Binary - - Pdf - - Pptx - - Feather + calculationId: + description: Calculation identifier type: string type: object - FICalculationParametersRoot: + CalculationInfoRoot: + properties: + data: + $ref: '#/components/schemas/CalculationInfo' + meta: + type: object + required: + - data + type: object + ObjectRoot: example: + data: '{}' + meta: '{}' + properties: data: - jobSettings: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 7 - - 7 - settlement: settlement - calculations: - - calculations - - calculations - securities: - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 1.4894159098541704 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 6.84685269835264 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 1.4894159098541704 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 6.84685269835264 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + type: object meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + type: object + required: + - data + type: object + AxiomaEquityOptimizerStrategyOverrides: + example: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + properties: + objective: + description: Objective + type: string + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost + type: string + type: object + AxiomaEquityOptimizerStrategy: + example: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + properties: + overrides: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + AxiomaEquityOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: + strategy: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + AxiomaEquityOptimizationParametersRoot: + example: data: - $ref: '#/components/schemas/FICalculationParameters' + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' meta: - $ref: '#/components/schemas/CalculationMeta' + type: object type: object - PaDoc: + SPARIdentifier: + description: The account/benchmark parameter for SPAR calculation. example: + prefix: prefix + returntype: returntype id: id properties: id: - description: PA document path + description: User's FactSet account OR benchmark id. + type: string + returntype: + description: Account or benchmark return type. + type: string + prefix: + description: Account or benchmark prefix. type: string required: - id type: object - FPOAccount: + SPARBenchmark: example: - paDocument: + identifiers: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype id: id + name: name id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark properties: - paDocument: - $ref: '#/components/schemas/PaDoc' id: - description: Account path + description: Benchmark identifier type: string - overrides: - $ref: '#/components/schemas/OptimizerAccountOverrides' + name: + description: Benchmark Name + type: string + identifiers: + description: List of SPAR identifiers + items: + $ref: '#/components/schemas/SPARIdentifier' + type: array + type: object + SPARBenchmarkRoot: + 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: - - paDocument + - data type: object - FPOObjective: + ConstraintAction: example: - terms: - key: Disable - active: active + item2: Disable + item1: item1 properties: - active: + item1: + type: string + item2: + enum: + - Disable + - Enable type: string - terms: - additionalProperties: - enum: - - Disable - - Enable - type: string - type: object type: object - FPOOptimizerStrategyOverrides: + BPMOptimizerStrategyAlphaOverride: example: - alpha: alpha + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + properties: + formula: + type: string + returnType: + enum: + - Excess + - Total + - Active + - Residual + - Exceptional + type: string + returnMultiplier: + type: string + type: object + BPMOptimizerStrategyOverrides: + example: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax transactionCost: transactionCost constraints: - key: Disable - objective: - terms: - key: Disable - active: active + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 properties: - objective: - $ref: '#/components/schemas/FPOObjective' constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string description: List of constraints - type: object + items: + $ref: '#/components/schemas/ConstraintAction' + type: array alpha: - description: Alpha + $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' + tax: + description: "Tax\r\nCan be set to \"\" for local" type: string transactionCost: - description: Transaction cost + description: "Transaction cost\r\nCan be set to \"\" for local" type: string type: object - FPOOptimizerStrategy: + BPMOptimizerStrategy: example: overrides: - alpha: alpha + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax transactionCost: transactionCost constraints: - key: Disable - objective: - terms: - key: Disable - active: active + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 id: id properties: overrides: - $ref: '#/components/schemas/FPOOptimizerStrategyOverrides' + $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' id: description: OptimizerStrategy document path type: string required: - id type: object - FPOOptimizationParameters: + BPMOptimization: + example: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + properties: + market: + description: Optimization market + type: string + investAllCash: + description: Optimization invest all cash + type: boolean + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow + type: string + type: object + BPMOptimizationParameters: example: optimization: + market: market + investAllCash: true cashflow: cashflow riskModelDate: riskModelDate backtestDate: backtestDate @@ -42746,18 +28179,19 @@ components: acctName: acctName strategy: overrides: - alpha: alpha + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax transactionCost: transactionCost constraints: - key: Disable - objective: - terms: - key: Disable - active: active + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 id: id account: - paDocument: - id: id id: id overrides: portfolio: portfolio @@ -42765,22 +28199,24 @@ components: currency: currency benchmark: benchmark properties: - account: - $ref: '#/components/schemas/FPOAccount' strategy: - $ref: '#/components/schemas/FPOOptimizerStrategy' + $ref: '#/components/schemas/BPMOptimizerStrategy' optimization: - $ref: '#/components/schemas/Optimization' + $ref: '#/components/schemas/BPMOptimization' + account: + $ref: '#/components/schemas/OptimizerAccount' outputTypes: $ref: '#/components/schemas/OptimizerOutputTypes' required: - outputTypes - strategy type: object - FPOOptimizationParametersRoot: + BPMOptimizationParametersRoot: example: data: optimization: + market: market + investAllCash: true cashflow: cashflow riskModelDate: riskModelDate backtestDate: backtestDate @@ -42801,18 +28237,19 @@ components: acctName: acctName strategy: overrides: - alpha: alpha + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax transactionCost: transactionCost constraints: - key: Disable - objective: - terms: - key: Disable - active: active + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 id: id account: - paDocument: - id: id id: id overrides: portfolio: portfolio @@ -42822,2751 +28259,2469 @@ components: meta: '{}' properties: data: - $ref: '#/components/schemas/FPOOptimizationParameters' + $ref: '#/components/schemas/BPMOptimizationParameters' meta: type: object type: object - Frequency: + ComponentSummary: example: name: name + category: category properties: name: - description: Frequency name. + description: Component name. + type: string + category: + description: Component category. type: string type: object - FrequencyRoot: + ComponentSummaryRoot: example: data: key: name: name + category: category meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/Frequency' + $ref: '#/components/schemas/ComponentSummary' type: object meta: type: object required: - data type: object - Group: + SPARComponent: example: + path: path name: name + id: id + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmarks: + prefix: prefix + returntype: returntype + id: id + currencyIsoCode: currencyIsoCode category: category - directory: directory properties: - name: - description: Group Name + id: + description: Component identifier. + type: string + accounts: + description: List of accounts in SPAR document. + items: + $ref: '#/components/schemas/SPARIdentifier' + type: array + benchmarks: + $ref: '#/components/schemas/SPARIdentifier' + currencyIsoCode: + description: CurrencyCode in SPAR document. + type: string + path: + description: The path to the document type: string - directory: - description: Group Directory + name: + description: Component name. type: string category: - description: Group Category + description: Component category. type: string type: object - GroupRoot: + SPARComponentRoot: example: data: - key: - name: name - category: category - directory: directory - meta: '{}' + path: path + name: name + id: id + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmarks: + prefix: prefix + returntype: returntype + id: id + currencyIsoCode: currencyIsoCode + category: category properties: data: - additionalProperties: - $ref: '#/components/schemas/Group' - type: object - meta: - type: object + $ref: '#/components/schemas/SPARComponent' + type: object + VaultIdentifier: + description: The account/benchmark parameter for Vault calculation. + example: + id: id + properties: + id: + description: User's FactSet account path OR benchmark. + type: string required: - - data + - id type: object - TemplateContentTypes: + VaultDateParameters: + description: The date parameters for Vault calculation example: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + enddate: enddate + startdate: startdate + frequency: frequency properties: - mandatory: - description: Template mandatory fields - items: - type: string - type: array - optional: - description: Template optional fields - items: - type: string - type: array - locked: - description: Template locked fields - items: - type: string - type: array + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency type: object - LinkedPATemplateParameters: + VaultComponent: example: - parentComponentId: parentComponentId - description: description - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: + id: id + snapshot: true properties: - directory: - description: The directory to create a linked PA template + id: + description: Vault component identifier + type: string + account: + $ref: '#/components/schemas/VaultIdentifier' + benchmark: + $ref: '#/components/schemas/VaultIdentifier' + currencyisocode: + description: Currency iso code saved in the document + type: string + dates: + $ref: '#/components/schemas/VaultDateParameters' + snapshot: + description: Snapshot + type: boolean + path: + description: The path to the document type: string - parentComponentId: - description: Parent component id + name: + description: Component name. type: string - description: - description: Template description + category: + description: Component category. type: string - content: - $ref: '#/components/schemas/TemplateContentTypes' + type: object + VaultComponentRoot: + example: + data: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: + id: id + snapshot: true + meta: '{}' + properties: + data: + $ref: '#/components/schemas/VaultComponent' + meta: + type: object required: - - directory - - parentComponentId + - data + type: object + VaultConfigurationSummary: + example: + name: name + properties: + name: + description: Configuration name. + type: string type: object - LinkedPATemplateParametersRoot: + VaultConfigurationSummaryRoot: example: data: - parentComponentId: parentComponentId - description: description - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + key: + name: name meta: '{}' properties: data: - $ref: '#/components/schemas/LinkedPATemplateParameters' + additionalProperties: + $ref: '#/components/schemas/VaultConfigurationSummary' + type: object meta: type: object required: - data type: object - LinkedPATemplatePostSummary: + ConfigurationAccount: example: - parentComponentId: parentComponentId + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate name: name - description: description - id: id + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName properties: - id: - description: Template id. + benchmarkCode: + description: Benchmark code. + type: string + benchmarkName: + description: Benchmark name. + type: string + maxEndDate: + description: Maximum end date. + type: string + minStartDate: + description: Minimum start date. type: string - description: - description: Template description. + lockingDate: + description: Locking date. type: string name: - description: Template name. + description: Account name. type: string - parentComponentId: - description: Template parent tile. + type: object + VaultConfiguration: + example: + name: name + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + properties: + name: + description: Configuration name. type: string + accounts: + additionalProperties: + $ref: '#/components/schemas/ConfigurationAccount' + type: object type: object - LinkedPATemplatePostSummaryRoot: + VaultConfigurationRoot: example: data: - parentComponentId: parentComponentId name: name - description: description - id: id + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName meta: '{}' properties: data: - $ref: '#/components/schemas/LinkedPATemplatePostSummary' + $ref: '#/components/schemas/VaultConfiguration' meta: type: object required: - data type: object - LinkedPATemplateSummary: + Currency: + description: Details of the currency. example: - parentComponentId: parentComponentId name: name - description: description properties: - description: - description: Template description. - type: string name: - description: Template name. - type: string - parentComponentId: - description: Template parent tile. + description: Name of currency. type: string type: object - LinkedPATemplateSummaryRoot: + CurrencyRoot: example: data: key: - parentComponentId: parentComponentId name: name - description: description meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/LinkedPATemplateSummary' + $ref: '#/components/schemas/Currency' type: object meta: type: object required: - data type: object - LinkedPATemplateUpdateParameters: + DateParametersSummary: example: - parentComponentId: parentComponentId - description: description - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + enddate: enddate + startdate: startdate properties: - parentComponentId: - description: Parent component id + startdate: + description: Start date in YYYYMMDD format. type: string - description: - description: Template description + enddate: + description: End date in YYYYMMDD format. type: string - content: - $ref: '#/components/schemas/TemplateContentTypes' type: object - LinkedPATemplateUpdateParametersRoot: + DateParametersSummaryRoot: example: data: - parentComponentId: parentComponentId - description: description - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + enddate: enddate + startdate: startdate meta: '{}' properties: data: - $ref: '#/components/schemas/LinkedPATemplateUpdateParameters' + $ref: '#/components/schemas/DateParametersSummary' meta: type: object required: - data type: object - LinkedPATemplate: + FIDiscountCurveInfo: example: - parentComponentId: parentComponentId name: name - description: description - id: id - directory: directory - snapshot: true - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + currency: currency + category: category properties: - directory: - description: Template directory. - type: string - snapshot: - description: snapshot. - type: boolean - content: - $ref: '#/components/schemas/TemplateContentTypes' - id: - description: Template id. - type: string - description: - description: Template description. + category: type: string name: - description: Template name. - type: string - parentComponentId: - description: Template parent tile. - type: string - type: object - LinkedPATemplateRoot: - example: - data: - parentComponentId: parentComponentId - name: name - description: description - id: id - directory: directory - snapshot: true - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory - meta: '{}' - properties: - data: - $ref: '#/components/schemas/LinkedPATemplate' - meta: - type: object - required: - - data - type: object - NPOOptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - properties: - objective: - additionalProperties: - type: object - description: Objective parameters - type: object - constraints: - description: List of constraints - items: - $ref: '#/components/schemas/ConstraintAction' - type: array - tax: - description: "Tax\r\nCan be set to \"\" for local" - type: string - transactionCost: - description: "Transaction cost\r\nCan be set to \"\" for local" - type: string - alpha: - description: Alpha type: string - type: object - NPOOptimizerStrategy: - example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - properties: - overrides: - $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path + currency: type: string - required: - - id - type: object - NPOOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/NPOOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy type: object - NPOOptimizationParametersRoot: + FIDiscountCurveInfoRoot: example: data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + key: + name: name + currency: currency + category: category meta: '{}' properties: data: - $ref: '#/components/schemas/NPOOptimizationParameters' + additionalProperties: + $ref: '#/components/schemas/FIDiscountCurveInfo' + type: object meta: type: object + required: + - data type: object - PACalculationGroup: - example: - id: id - frequency: frequency - properties: - id: - description: FactSet-defined or User-defined Group identifier. - type: string - frequency: - description: Grouping frequency - type: string - type: object - PACalculationColumn: + DocumentDirectories: example: - id: id - statistics: - - statistics - - statistics + documents: + - documents + - documents + directories: + - directories + - directories properties: - id: - description: FactSet-defined or User-defined Column identifier. - type: string - statistics: - description: Column Statistic identifier + documents: + description: List of documents + items: + type: string + type: array + directories: + description: List of directories. items: type: string type: array type: object - PACalculationPricingSource: + DocumentDirectoriesRoot: + example: + data: + documents: + - documents + - documents + directories: + - directories + - directories + meta: '{}' + properties: + data: + $ref: '#/components/schemas/DocumentDirectories' + meta: + type: object + required: + - data + type: object + FIABIdentifier: example: id: id properties: id: - description: Pricing source identifier + description: User's FactSet account path. type: string + required: + - id type: object - PACalculationDataSources: + FIABDateParameters: + description: The date parameters for FIAB calculations. example: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id + enddate: enddate + startdate: startdate properties: - portfoliopricingsources: - description: List of portfilio pricing source for the PA calculation - items: - $ref: '#/components/schemas/PACalculationPricingSource' - type: array - benchmarkpricingsources: - description: List of benchmark pricing source for the PA calculation - items: - $ref: '#/components/schemas/PACalculationPricingSource' - type: array - useportfoliopricingsourcesforbenchmark: - description: Use portfolio pricing sources for benchmark - type: boolean + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + required: + - enddate + - startdate type: object - PACalculationParameters: + FIABCalculationParameters: example: - currencyisocode: currencyisocode - componentdetail: componentdetail - componentid: componentid - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency + fiabdocument: fiabdocument + msl: msl dates: enddate: enddate startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode + fisettingsdocument: fisettingsdocument + account: + id: id properties: - componentid: - description: The PA Engine component identifier to analyze. + fiabdocument: + description: "FiabDocument (optional) - FIAB document to use as a template.\ + \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" type: string - accounts: - description: List of accounts. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array + account: + $ref: '#/components/schemas/FIABIdentifier' dates: - $ref: '#/components/schemas/PADateParameters' - groups: - description: List of groupings for the PA calculation. This will take precedence - over the groupings saved in the PA document. - items: - $ref: '#/components/schemas/PACalculationGroup' - type: array - currencyisocode: - description: Currency ISO code for calculation. + $ref: '#/components/schemas/FIABDateParameters' + msl: + description: Master FISecurity List. Analytics results will be written to + the selected MSL. Expects a GUI-style path (Client:/foo/bar) type: string - columns: - description: List of columns for the PA calculation. This will take precedence - over the columns saved in the PA document. - items: - $ref: '#/components/schemas/PACalculationColumn' - type: array - datasources: - $ref: '#/components/schemas/PACalculationDataSources' - componentdetail: - description: Component detail type for the PA component. It can be GROUPS - or GROUPSALL or TOTALS or SECURITIES. + fisettingsdocument: + description: "FISettingsDocument (optional) - The given @FIS document will\ + \ be used to\r\nconfigure analytics assumptions and settings. Expects\ + \ a GUI-style path (Client:/foo/bar)" type: string required: - - componentid + - account + - dates type: object - PACalculationParametersRoot: - example: - data: - key: - currencyisocode: currencyisocode - componentdetail: componentdetail - componentid: componentid - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + FIABCalculationStatusSummary: properties: - data: - additionalProperties: - $ref: '#/components/schemas/PACalculationParameters' - description: List of calculation parameters. - type: object - meta: - $ref: '#/components/schemas/CalculationMeta' + requesttime: + description: Request time of calculation. + format: date-time + type: string + lastpolltime: + description: Last poll time of calculation. + format: date-time + type: string type: object - CalculationUnitStatus: + EventSummary: example: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 + submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type properties: - status: - description: The status of calculation unit. - enum: - - Queued - - Executing - - Success - - Failed - - Cancelled + message: + description: Event's message type: string - errors: - description: The error in a calculation unit. - items: - $ref: '#/components/schemas/Error' - type: array - result: - description: The result URL of the calculation. + submissiondatetime: + description: Event's submission time + format: date-time type: string - progress: - description: The progress of the calculation unit. + type: + description: Event's type type: string - points: - 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: + FIABCalculationStatus: example: - calculationid: calculationid - units: - key: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 - status: Queued + completiondatetime: 2000-01-23T04:56:07.000+00:00 + batchevents: + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + progress: 0 + id: id + status: Pending + startdatetime: 2000-01-23T04:56:07.000+00:00 properties: - calculationid: + id: description: Calculation's identifier type: string status: description: Calculation's status enum: - - Queued - - Executing - - Completed + - Pending + - InProgress + - Done + - Paused - Cancelled + - Error type: string - units: - additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatus' - description: Number of calculation units in batch. - type: object + startdatetime: + description: Start time + format: date-time + type: string + completiondatetime: + description: Completion time + format: date-time + type: string + progress: + description: Calculation's progress + format: int32 + type: integer + batchevents: + description: List of batch events + items: + $ref: '#/components/schemas/EventSummary' + type: array type: object - CalculationUnitStatusMeta: + FIReferencePrepay: example: - info: info + prepayName: prepayName properties: - info: - description: The Info URL of the calculation. + prepayName: + description: Reference Prepay Name type: string type: object - CalculationStatusMeta: + FIReferenceSecurity: example: - units: - key: - info: info + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement properties: - units: - additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatusMeta' - description: Meta of calculation units in batch. - type: object + securityType: + description: Reference Security Type + type: string + securityName: + description: Reference Security Name + type: string + calcFromMethod: + description: "Reference Calculation Method.\r\nMethods : Active Spread,\ + \ Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield\ + \ To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield\ + \ To Worst Call, Discount Yield, Discount Margin, Implied Volatility,\ + \ Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + type: string + calcFromValue: + description: Reference CalcFromValue + format: double + type: number + prepay: + $ref: '#/components/schemas/FIReferencePrepay' + settlement: + description: Reference Settlement Date + type: string type: object - CalculationStatusRoot: + FIBankLoans: example: - data: - calculationid: calculationid - units: - key: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 - status: Queued - meta: - units: - key: - info: info + ignoreSinkingFund: true properties: - data: - $ref: '#/components/schemas/CalculationStatus' - meta: - $ref: '#/components/schemas/CalculationStatusMeta' - required: - - data + ignoreSinkingFund: + description: Ignore Sinking Fund + type: boolean type: object - CalculationsSummary: + FIMunicipalBonds: example: - requestTime: 2000-01-23T04:56:07.000+00:00 - lastPollTime: 2000-01-23T04:56:07.000+00:00 - units: 0 - status: Queued + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true properties: - status: - description: Last poll status of the calculation. - enum: - - Queued - - Executing - - Completed - - Cancelled - type: string - units: - description: Number of calculation units in batch. - format: int32 - type: integer - requestTime: - description: Request time of calculation. - format: date-time - type: string - lastPollTime: - description: Last poll time of calculation. - format: date-time - type: string + ignoreSinkingFund: + description: Ignore Sinking Fund Schedule + type: boolean + useAnticipatedSinkSchedule: + description: Anticipate Sink Schedule + type: boolean type: object - PaginationInfo: + FILoss: example: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 + lossName: lossName properties: - pageNumber: - format: int32 - type: integer - pageSize: - format: int32 - type: integer - totalPages: - format: int32 - type: integer - totalCalculations: - format: int32 - type: integer - nextPage: - type: string - previousPage: + lossName: + description: Loss Name type: string type: object - PaginationMeta: + FIPrepay: example: - pagination: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 + prepayName: prepayName properties: - pagination: - $ref: '#/components/schemas/PaginationInfo' + prepayName: + description: Prepay Name + type: string type: object - CalculationsSummaryRoot: + FIServicerAdvancesForSecurities: example: - data: - key: - requestTime: 2000-01-23T04:56:07.000+00:00 - lastPollTime: 2000-01-23T04:56:07.000+00:00 - units: 0 - status: Queued - meta: - pagination: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All properties: - data: - additionalProperties: - $ref: '#/components/schemas/CalculationsSummary' - type: object - meta: - $ref: '#/components/schemas/PaginationMeta' - required: - - data + principal: + description: Principal + format: double + type: number + interest: + description: Interest + format: double + type: number + advanceType: + description: Advance Type + enum: + - Advances All + - Advances All But Newly Liqdtd + - Does Not Advance + - Principal Only + - Interest Only + type: string type: object - PAPricingSource: + FIPrepayLockout: example: - name: name - category: category - directory: directory + pointsAbove: ANY + ymAbove: ANY properties: - name: - description: Pricing source Name - type: string - directory: - description: Pricing source directory + pointsAbove: + description: Points Above + enum: + - ANY + - NO_LOCKOUT + - NUMERIC type: string - category: - description: Pricing source category + ymAbove: + description: Ym Above + enum: + - ANY + - NO_LOCKOUT + - NUMERIC type: string type: object - PAPricingSourceRoot: + FICashflows: example: - data: - key: - name: name - category: category - directory: directory - meta: '{}' + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 properties: - data: - additionalProperties: - $ref: '#/components/schemas/PAPricingSource' - type: object - meta: - type: object - required: - - data + optionalRedemptionCallWhenUnits: + description: OptionalRedemptionCallWhenUnits + enum: + - Manual + - Never + - ASAP + - Date + - Deal Closing + - Settle Date + type: string + optionalRedemptionCallWhen: + description: OptionalRedemptionCallWhen + format: int32 + type: integer + recoveryLag: + description: RecoveryLag + format: int32 + type: integer type: object - PubIdentifier: + FIBalloonExtension: example: - id: id - holdingsmode: holdingsmode + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 properties: - id: - description: User's FactSet account path OR benchmark. + months: + description: Months + format: int32 + type: integer + percentage: + description: Percentage + format: double + type: number + amortizationType: + description: Amortization Type + enum: + - Loan_Amort_None + - Loan_Amort_Regular + - Loan_Amort_Default type: string - holdingsmode: - description: Holdings Mode can be B&H, TBR, OMS or EXT. + units: + description: Units type: string - required: - - id + couponStepup: + description: Coupon Stepup + format: double + type: number type: object - PubDateParameters: - description: The date parameters for Publisher calculation. + FIStructuredProductsForSecurities: example: - enddate: enddate - startdate: startdate + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 properties: - startdate: - description: Calculation's start date. + servicerAdvances: + $ref: '#/components/schemas/FIServicerAdvancesForSecurities' + ignoreFinancialGuarantee: + description: Ignore Financial Guarantee type: string - enddate: - description: Calculation's end date or as of date. + cleanUpCallMethod: + description: Cleanup Call Method + type: boolean + doOPTRedeem: + description: Do OPT Redeem type: string - required: - - enddate + prepayLockout: + $ref: '#/components/schemas/FIPrepayLockout' + cashflows: + $ref: '#/components/schemas/FICashflows' + balloonExtension: + $ref: '#/components/schemas/FIBalloonExtension' type: object - PubCalculationParameters: + FIAttributionForSecurities: example: - document: document - dates: - enddate: enddate - startdate: startdate - account: - id: id - holdingsmode: holdingsmode + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 properties: - document: - description: The Publisher Engine document to analyze. + startPrice: + description: Start Price + format: double + type: number + endPrice: + description: End Price + format: double + type: number + startSpread: + description: Start Spread + format: double + type: number + endSpread: + description: End Spread + format: double + type: number + pricingMethod: + description: Pricing Method + enum: + - Inputted Price + - Pricing Matrix + - Actual Spread + - OAS type: string - account: - $ref: '#/components/schemas/PubIdentifier' - dates: - $ref: '#/components/schemas/PubDateParameters' - required: - - account - - dates - - document - type: object - PubCalculationMeta: type: object - PubCalculationParametersRoot: + FIConvertibleSettings: example: - data: - key: - document: document - dates: - enddate: enddate - startdate: startdate - account: - id: id - holdingsmode: holdingsmode - meta: '{}' + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 properties: - data: - additionalProperties: - $ref: '#/components/schemas/PubCalculationParameters' - description: List of calculation parameters. - type: object - meta: - type: object + equityPrice: + description: Equity Price + format: double + type: number + equityIndexVolatility: + description: Equity Index Volatility + format: double + type: number + equityDividendYield: + description: Equity Dividend Yield + format: double + type: number + volatilityCapMethod: + description: Volatility CapMethod + enum: + - noCap + - specifiedRate + - multiplier + type: string + volatilityCapMethodValue: + description: Volatility CapMethod Value - (Required only when volatilityCapMethod + is specifiedRate or multiplier) + format: double + type: number + equityExchangeRate: + description: Equity Exchange Rate + format: double + type: number type: object - QuantScreeningExpressionUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' + FISecurity: + example: + callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 properties: - universeExpr: + settlement: + description: Settlement date type: string - universeType: + callMethod: + description: Call Method enum: - - Equity - - Debt + - No Call + - Intrinsic Value + - First Call + - First Par type: string - securityExpr: + referenceSecurity: + $ref: '#/components/schemas/FIReferenceSecurity' + bankLoans: + $ref: '#/components/schemas/FIBankLoans' + municipalBonds: + $ref: '#/components/schemas/FIMunicipalBonds' + loss: + $ref: '#/components/schemas/FILoss' + prepay: + $ref: '#/components/schemas/FIPrepay' + matrixSpreadAdjustment: + description: Matrix Spread Adjustment + format: double + type: number + matrixMultiplier: + description: Matrix Multiplier + format: double + type: number + structuredProducts: + $ref: '#/components/schemas/FIStructuredProductsForSecurities' + attribution: + $ref: '#/components/schemas/FIAttributionForSecurities' + convertible: + $ref: '#/components/schemas/FIConvertibleSettings' + calcFromMethod: + description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ + \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ + \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" type: string - required: - - universeExpr - - universeType - type: object - QuantIdentifierUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' - properties: - universeType: + calcFromValue: + description: Calculation from value + format: double + type: number + face: + default: 1 + description: Face + format: double + type: number + faceType: + default: Current + description: Face type enum: - - Equity - - Debt + - Current + - Original type: string - identifiers: - items: - type: string - type: array - required: - - identifiers - - universeType - type: object - QuantUniverse: - properties: - source: - enum: - - ScreeningExpressionUniverse - - UniversalScreenUniverse - - IdentifierUniverse + symbol: + description: Symbol type: string - required: - - source - type: object - QuantUniversalScreenUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' - properties: - screen: + discountCurve: + description: Discount curve type: string required: - - screen - type: object - QuantDateList: - allOf: - - $ref: '#/components/schemas/QuantDate' - properties: - dates: - items: - type: string - type: array + - calcFromValue + - symbol type: object - QuantDate: + FIMunicipalBondsForJobSettings: + example: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true properties: - source: - enum: - - FdsDate - - DateList - type: string - frequency: - type: string - calendar: - type: string - overrideUniversalScreenCalendar: + allowSinkForInstallmentPayment: + description: Allow Sink For Installment Payment type: boolean - required: - - calendar - - frequency - - source - type: object - QuantFdsDate: - allOf: - - $ref: '#/components/schemas/QuantDate' - properties: - startDate: - type: string - endDate: - type: string - required: - - endDate - - startDate - type: object - QuantFqlExpression: - allOf: - - $ref: '#/components/schemas/QuantFormula' - properties: - expr: - type: string - name: - type: string - dateOffset: - type: string - isArrayReturnType: + ignoreSinkingFund: + description: Ignore Sinking Fund Schedule + type: boolean + useAnticipatedSinkSchedule: + description: Anticipate Sink Schedule type: boolean - required: - - expr - - name - type: object - QuantUniversalScreenParameter: - allOf: - - $ref: '#/components/schemas/QuantFormula' - properties: - referenceName: - type: string - name: - type: string - required: - - name - - referenceName - type: object - QuantAllUniversalScreenParameters: - allOf: - - $ref: '#/components/schemas/QuantFormula' type: object - QuantFormula: + FIMarketEnvironment: + example: + ratePath: FLAT & FORWARD properties: - source: + ratePath: + default: FLAT & FORWARD + description: Rate Path enum: - - ScreeningExpression - - FqlExpression - - UniversalScreenParameter - - AllUniversalScreenParameters + - FLAT + - FORWARD + - FLAT & FORWARD type: string - required: - - source type: object - QuantScreeningExpression: - allOf: - - $ref: '#/components/schemas/QuantFormula' + FIServicerAdvances: + example: + advanceType: Advances All properties: - expr: - type: string - name: - type: string - dateOffset: + advanceType: + description: Advance Type + enum: + - Advances All + - Advances All But Newly Liqdtd + - Does Not Advance + - Principal Only + - Interest Only type: string - required: - - expr - - name type: object - QuantScreeningExpressionUniverseObsolete: + FIStructuredProductsForJobSettings: + example: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 properties: - universeExpr: - type: string - universeType: - enum: - - Equity - - Debt - type: string - securityExpr: - type: string - source: - enum: - - ScreeningExpressionUniverse - - UniversalScreenUniverse - - IdentifierUniverse + servicerAdvances: + $ref: '#/components/schemas/FIServicerAdvances' + ignoreFinancialGuarantee: + description: Ignore Financial Guarantee type: string - required: - - universeExpr - - universeType + cleanUpCallMethod: + description: Cleanup Call Method + type: boolean + doOPTRedeem: + description: Do OPT Redeem + type: string + prepayLockout: + $ref: '#/components/schemas/FIPrepayLockout' + cashflows: + $ref: '#/components/schemas/FICashflows' + balloonExtension: + $ref: '#/components/schemas/FIBalloonExtension' type: object - QuantUniversalScreenUniverseObsolete: + FIAttributionForJobSettings: + example: + endDate: endDate + startDate: startDate properties: - screen: + startDate: + description: Start Date type: string - source: - enum: - - ScreeningExpressionUniverse - - UniversalScreenUniverse - - IdentifierUniverse + endDate: + description: End Date type: string - required: - - screen type: object - QuantIdentifierUniverseObsolete: + FIJobSettings: + example: + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement properties: - universeType: - enum: - - Equity - - Debt + asOfDate: + description: As of date type: string - identifiers: + partialDurationMonths: + description: Partial duration months items: - type: string + format: int32 + type: integer type: array - source: + callMethod: + description: Call Method enum: - - ScreeningExpressionUniverse - - UniversalScreenUniverse - - IdentifierUniverse - type: string - required: - - identifiers - - universeType - type: object - QuantFdsDateObsolete: - properties: - startDate: - type: string - endDate: + - No Call + - Intrinsic Value + - First Call + - First Par type: string - frequency: + settlement: + description: Settlement Date type: string - calendar: + calcFromMethod: + description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ + \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ + \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" type: string - overrideUniversalScreenCalendar: - type: boolean + bankLoans: + $ref: '#/components/schemas/FIBankLoans' + municipalBonds: + $ref: '#/components/schemas/FIMunicipalBondsForJobSettings' + marketEnvironment: + $ref: '#/components/schemas/FIMarketEnvironment' + structuredProducts: + $ref: '#/components/schemas/FIStructuredProductsForJobSettings' + attribution: + $ref: '#/components/schemas/FIAttributionForJobSettings' required: - - calendar - - endDate - - frequency - - startDate + - asOfDate type: object - QuantDateListObsolete: + FICalculationParameters: + example: + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 properties: - dates: + securities: + description: List of securities + items: + $ref: '#/components/schemas/FISecurity' + type: array + calculations: + description: List of calculations items: type: string type: array - frequency: - type: string - calendar: - type: string - overrideUniversalScreenCalendar: - type: boolean + jobSettings: + $ref: '#/components/schemas/FIJobSettings' required: - - calendar - - frequency + - calculations + - jobSettings + - securities type: object - QuantScreeningExpressionObsolete: + CalculationMeta: + example: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: - expr: - type: string - name: - type: string - dateOffset: + contentorganization: + default: SimplifiedRow + deprecated: true + enum: + - None + - Row + - Column + - SimplifiedRow type: string - required: - - expr - - name - type: object - QuantFqlExpressionObsolete: - properties: - expr: + stachContentOrganization: + default: SimplifiedRow + enum: + - None + - Row + - Column + - SimplifiedRow type: string - name: + contenttype: + default: Json + deprecated: true + enum: + - Json + - Binary type: string - dateOffset: + format: + default: JsonStach + enum: + - JsonStach + - Table + - Tableau + - BinaryStach + - Bison + - Binary + - Pdf + - Pptx + - Feather type: string - isArrayReturnType: - type: boolean - required: - - expr - - name type: object - QuantUniversalScreenParameterObsolete: + FICalculationParametersRoot: + example: + data: + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json + properties: + data: + $ref: '#/components/schemas/FICalculationParameters' + meta: + $ref: '#/components/schemas/CalculationMeta' + type: object + Frequency: + example: + name: name properties: - referenceName: - type: string name: + description: Frequency name. type: string - required: - - name - - referenceName type: object - QuantAllUniversalScreenParametersObsolete: + FrequencyRoot: + example: + data: + key: + name: name + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/Frequency' + type: object + meta: + type: object + required: + - data type: object - OneOfQuantUniverse: - discriminator: - mapping: - UniversalScreenUniverse: '#/components/schemas/QuantUniversalScreenUniverse' - ScreeningExpressionUniverse: '#/components/schemas/QuantScreeningExpressionUniverse' - IdentifierUniverse: '#/components/schemas/QuantIdentifierUniverse' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantUniversalScreenUniverse' - - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' - - $ref: '#/components/schemas/QuantIdentifierUniverse' - OneOfQuantDates: - discriminator: - mapping: - FdsDate: '#/components/schemas/QuantFdsDate' - DateList: '#/components/schemas/QuantDateList' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantFdsDate' - - $ref: '#/components/schemas/QuantDateList' - OneOfQuantFormulas: - discriminator: - mapping: - ScreeningExpression: '#/components/schemas/QuantScreeningExpression' - FqlExpression: '#/components/schemas/QuantFqlExpression' - UniversalScreenParameter: '#/components/schemas/QuantUniversalScreenParameter' - AllUniversalScreenParameters: '#/components/schemas/QuantAllUniversalScreenParameters' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantScreeningExpression' - - $ref: '#/components/schemas/QuantFqlExpression' - - $ref: '#/components/schemas/QuantUniversalScreenParameter' - - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' - OneOfQuantFormulasArray: - items: - $ref: '#/components/schemas/OneOfQuantFormulas' - type: array - QuantCalculationParameters: + NPOOptimizerStrategyOverrides: example: - formulas: - - null - - null - jobDescription: jobDescription + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' properties: - universe: - $ref: '#/components/schemas/OneOfQuantUniverse' - dates: - $ref: '#/components/schemas/OneOfQuantDates' - formulas: + objective: + additionalProperties: + type: object + description: Objective parameters + type: object + constraints: + description: List of constraints items: - $ref: '#/components/schemas/OneOfQuantFormulas' + $ref: '#/components/schemas/ConstraintAction' type: array - jobDescription: + tax: + description: "Tax\r\nCan be set to \"\" for local" + type: string + transactionCost: + description: "Transaction cost\r\nCan be set to \"\" for local" + type: string + alpha: + description: Alpha type: string type: object - QuantCalculationMeta: + NPOOptimizerStrategy: example: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id properties: - allowArrayData: - type: boolean - contentorganization: - default: SimplifiedRow - deprecated: true - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - stachContentOrganization: - default: SimplifiedRow - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - contenttype: - default: Json - deprecated: true - enum: - - Json - - Binary - type: string - format: - default: JsonStach - enum: - - JsonStach - - Table - - Tableau - - BinaryStach - - Bison - - Binary - - Pdf - - Pptx - - Feather + overrides: + $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path type: string + required: + - id type: object - QuantCalculationParametersRoot: + NPOOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/NPOOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + NPOOptimizationParametersRoot: example: data: - key: - formulas: - - null - - null - jobDescription: jobDescription - meta: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' properties: data: - additionalProperties: - $ref: '#/components/schemas/QuantCalculationParameters' - description: List of calculation parameters. - type: object + $ref: '#/components/schemas/NPOOptimizationParameters' meta: - $ref: '#/components/schemas/QuantCalculationMeta' + type: object type: object - SPARDateParameters: - description: The date parameters for SPAR calculation. + PubIdentifier: + example: + id: id + holdingsmode: holdingsmode + properties: + id: + description: User's FactSet account path OR benchmark. + type: string + holdingsmode: + description: Holdings Mode can be B&H, TBR, OMS or EXT. + type: string + required: + - id + type: object + PubDateParameters: + description: The date parameters for Publisher calculation. example: enddate: enddate startdate: startdate - frequency: frequency properties: startdate: description: Calculation's start date. type: string enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. + description: Calculation's end date or as of date. type: string required: - enddate - - frequency - - startdate type: object - SPARCalculationParameters: + PubCalculationParameters: example: - currencyisocode: currencyisocode - componentid: componentid + document: document 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 + account: id: id + holdingsmode: holdingsmode properties: - componentid: - description: The SPAR Engine component identifier to analyze. + document: + description: The Publisher Engine document to analyze. type: string - accounts: - description: List of accounts for SPAR calculation. - items: - $ref: '#/components/schemas/SPARIdentifier' - type: array - benchmark: - $ref: '#/components/schemas/SPARIdentifier' + account: + $ref: '#/components/schemas/PubIdentifier' dates: - $ref: '#/components/schemas/SPARDateParameters' - currencyisocode: - description: Currency ISO code for calculation. - type: string + $ref: '#/components/schemas/PubDateParameters' required: - - componentid + - account + - dates + - document type: object - SPARCalculationParametersRoot: + PubCalculationMeta: + type: object + PubCalculationParametersRoot: example: data: key: - currencyisocode: currencyisocode - componentid: componentid + document: document 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 + account: id: id - meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + holdingsmode: holdingsmode + meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/SPARCalculationParameters' + $ref: '#/components/schemas/PubCalculationParameters' description: List of calculation parameters. type: object meta: - $ref: '#/components/schemas/CalculationMeta' + type: object type: object - PAComponentData: + CalculationUnitStatus: + description: The status of the calculation as per FactSets API standards example: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 properties: - accounts: - description: List of accounts. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks. - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - groups: - description: List of groupings for the PA calculation. This will take precedence - over the groupings saved in the PA document. - items: - $ref: '#/components/schemas/PACalculationGroup' - type: array - columns: - description: List of columns for the PA calculation. This will take precedence - over the columns saved in the PA document. + status: + description: The status of calculation unit. + enum: + - Queued + - Executing + - Success + - Failed + - Cancelled + type: string + errors: + description: The error in a calculation unit. items: - $ref: '#/components/schemas/PACalculationColumn' + $ref: '#/components/schemas/Error' type: array - dates: - $ref: '#/components/schemas/PADateParameters' - datasources: - $ref: '#/components/schemas/PACalculationDataSources' - currencyisocode: - description: Currency ISO code for calculation. + result: + description: The result URL of the calculation. type: string - componentdetail: - description: PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or - SECURITIES. + progress: + description: The progress of the calculation unit. type: string + points: + 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 - TemplatedPAComponentParameters: + CalculationStatus: + description: Details of the calculation. example: - parentTemplateId: parentTemplateId - description: description - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - directory: directory + calculationid: calculationid + units: + key: + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 + status: Queued properties: - directory: - description: Directory to create templated components - type: string - parentTemplateId: - description: Parent template id + calculationid: + description: Calculation's identifier type: string - description: - description: Component description. + status: + description: Calculation's status + enum: + - Queued + - Executing + - Completed + - Cancelled type: string - componentData: - $ref: '#/components/schemas/PAComponentData' - required: - - directory - - parentTemplateId - type: object - TemplatedPAComponentParametersRoot: - example: - data: - parentTemplateId: parentTemplateId - description: description - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - directory: directory - meta: '{}' - properties: - data: - $ref: '#/components/schemas/TemplatedPAComponentParameters' - meta: + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatus' + description: Number of calculation units in batch. type: object - required: - - data type: object - TemplatedPAComponentPostSummary: + CalculationUnitStatusMeta: + description: Meta of the calculation unit. example: - parentTemplateId: parentTemplateId - name: name - description: description - id: id - type: type + info: info properties: - id: - type: string - description: - type: string - name: - type: string - parentTemplateId: - type: string - type: + info: + description: The Info URL of the calculation. type: string type: object - TemplatedPAComponentPostSummaryRoot: + CalculationStatusMeta: + description: Meta of calculation units in batch. + example: + units: + key: + info: info + properties: + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatusMeta' + description: List of calculation units in batch. + type: object + type: object + CalculationStatusRoot: example: data: - parentTemplateId: parentTemplateId - name: name - description: description - id: id - type: type - meta: '{}' + calculationid: calculationid + units: + key: + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 + status: Queued + meta: + units: + key: + info: info properties: data: - $ref: '#/components/schemas/TemplatedPAComponentPostSummary' + $ref: '#/components/schemas/CalculationStatus' meta: - type: object + $ref: '#/components/schemas/CalculationStatusMeta' required: - data type: object - TemplatedPAComponentSummary: + CalculationsSummary: example: - parentTemplateId: parentTemplateId - name: name - description: description - type: type + requestTime: 2000-01-23T04:56:07.000+00:00 + lastPollTime: 2000-01-23T04:56:07.000+00:00 + units: 0 + status: Queued properties: - description: + status: + description: Last poll status of the calculation. + enum: + - Queued + - Executing + - Completed + - Cancelled type: string - name: + units: + description: Number of calculation units in batch. + format: int32 + type: integer + requestTime: + description: Request time of calculation. + format: date-time type: string - parentTemplateId: + lastPollTime: + description: Last poll time of calculation. + format: date-time type: string - type: + type: object + PaginationInfo: + example: + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 + properties: + pageNumber: + format: int32 + type: integer + pageSize: + format: int32 + type: integer + totalPages: + format: int32 + type: integer + totalCalculations: + format: int32 + type: integer + nextPage: type: string + previousPage: + type: string + type: object + PaginationMeta: + example: + pagination: + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 + properties: + pagination: + $ref: '#/components/schemas/PaginationInfo' type: object - TemplatedPAComponentSummaryRoot: + CalculationsSummaryRoot: example: data: key: - parentTemplateId: parentTemplateId - name: name - description: description - type: type - meta: '{}' + requestTime: 2000-01-23T04:56:07.000+00:00 + lastPollTime: 2000-01-23T04:56:07.000+00:00 + units: 0 + status: Queued + meta: + pagination: + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 properties: data: additionalProperties: - $ref: '#/components/schemas/TemplatedPAComponentSummary' + $ref: '#/components/schemas/CalculationsSummary' type: object meta: - type: object + $ref: '#/components/schemas/PaginationMeta' required: - data type: object - TemplatedPAComponentUpdateParameters: - example: - parentTemplateId: parentTemplateId - description: description - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode + QuantScreeningExpressionUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' properties: - parentTemplateId: - description: Parent template id + universeExpr: + type: string + universeType: + enum: + - Equity + - Debt type: string - description: - description: Component description. + securityExpr: type: string - componentData: - $ref: '#/components/schemas/PAComponentData' + required: + - universeExpr + - universeType type: object - TemplatedPAComponentUpdateParametersRoot: - example: - data: - parentTemplateId: parentTemplateId - description: description - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - meta: '{}' + QuantIdentifierUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' properties: - data: - $ref: '#/components/schemas/TemplatedPAComponentUpdateParameters' - meta: - type: object + universeType: + enum: + - Equity + - Debt + type: string + identifiers: + items: + type: string + type: array required: - - data + - identifiers + - universeType type: object - TemplatedPAComponent: - example: - parentTemplateId: parentTemplateId - name: name - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - description: description - id: id - type: type - directory: directory - snapshot: true + QuantUniverse: properties: - id: - type: string - directory: + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse type: string - snapshot: - type: boolean - componentData: - $ref: '#/components/schemas/PAComponentData' - description: + required: + - source + type: object + QuantUniversalScreenUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' + properties: + screen: type: string - name: + required: + - screen + type: object + QuantDateList: + allOf: + - $ref: '#/components/schemas/QuantDate' + properties: + dates: + items: + type: string + type: array + type: object + QuantDate: + properties: + source: + enum: + - FdsDate + - DateList type: string - parentTemplateId: + frequency: type: string - type: + calendar: type: string + overrideUniversalScreenCalendar: + type: boolean + required: + - calendar + - frequency + - source type: object - TemplatedPAComponentRoot: - example: - data: - parentTemplateId: parentTemplateId - name: name - componentData: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - description: description - id: id - type: type - directory: directory - snapshot: true - meta: '{}' + QuantFdsDate: + allOf: + - $ref: '#/components/schemas/QuantDate' properties: - data: - $ref: '#/components/schemas/TemplatedPAComponent' - meta: - type: object + startDate: + type: string + endDate: + type: string required: - - data + - endDate + - startDate type: object - UnlinkedPATemplateParameters: - example: - templateTypeId: templateTypeId - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - description: description - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + QuantFqlExpression: + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - directory: - description: The directory to create an unlinked PA template + expr: type: string - templateTypeId: - description: Template type id + name: type: string - description: - description: Template description + dateOffset: type: string - accounts: - description: List of accounts - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - columns: - description: List of columns for the PA calculation - items: - $ref: '#/components/schemas/PACalculationColumn' - type: array - dates: - $ref: '#/components/schemas/PADateParameters' - groups: - description: List of groupings for the PA calculation - items: - $ref: '#/components/schemas/PACalculationGroup' - type: array - datasources: - $ref: '#/components/schemas/PACalculationDataSources' - currencyisocode: - description: Currency ISO code for calculation. + isArrayReturnType: + type: boolean + required: + - expr + - name + type: object + QuantUniversalScreenParameter: + allOf: + - $ref: '#/components/schemas/QuantFormula' + properties: + referenceName: type: string - componentdetail: - description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or - SECURITIES. + name: type: string - content: - $ref: '#/components/schemas/TemplateContentTypes' required: - - directory - - templateTypeId + - name + - referenceName type: object - UnlinkedPATemplateParametersRoot: - example: - data: - templateTypeId: templateTypeId - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - description: description - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory - meta: '{}' + QuantAllUniversalScreenParameters: + allOf: + - $ref: '#/components/schemas/QuantFormula' + type: object + QuantFormula: properties: - data: - $ref: '#/components/schemas/UnlinkedPATemplateParameters' - meta: - type: object + source: + enum: + - ScreeningExpression + - FqlExpression + - UniversalScreenParameter + - AllUniversalScreenParameters + type: string required: - - data + - source type: object - UnlinkedPATemplatePostSummary: - example: - name: name - description: description - id: id - category: category + QuantScreeningExpression: + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - id: - description: Template id. - type: string - description: - description: Template description. + expr: type: string name: - description: Template name. type: string - category: - description: Unlinked template category + dateOffset: type: string + required: + - expr + - name type: object - UnlinkedPATemplatePostSummaryRoot: + OneOfQuantUniverse: + discriminator: + mapping: + UniversalScreenUniverse: '#/components/schemas/QuantUniversalScreenUniverse' + ScreeningExpressionUniverse: '#/components/schemas/QuantScreeningExpressionUniverse' + IdentifierUniverse: '#/components/schemas/QuantIdentifierUniverse' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantUniversalScreenUniverse' + - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' + - $ref: '#/components/schemas/QuantIdentifierUniverse' + OneOfQuantDates: + discriminator: + mapping: + FdsDate: '#/components/schemas/QuantFdsDate' + DateList: '#/components/schemas/QuantDateList' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantFdsDate' + - $ref: '#/components/schemas/QuantDateList' + OneOfQuantFormulas: + discriminator: + mapping: + ScreeningExpression: '#/components/schemas/QuantScreeningExpression' + FqlExpression: '#/components/schemas/QuantFqlExpression' + UniversalScreenParameter: '#/components/schemas/QuantUniversalScreenParameter' + AllUniversalScreenParameters: '#/components/schemas/QuantAllUniversalScreenParameters' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantScreeningExpression' + - $ref: '#/components/schemas/QuantFqlExpression' + - $ref: '#/components/schemas/QuantUniversalScreenParameter' + - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' + OneOfQuantFormulasArray: + items: + $ref: '#/components/schemas/OneOfQuantFormulas' + type: array + QuantCalculationParameters: example: - data: - name: name - description: description - id: id - category: category - meta: '{}' + formulas: + - null + - null + jobDescription: jobDescription properties: - data: - $ref: '#/components/schemas/UnlinkedPATemplatePostSummary' - meta: - type: object - required: - - data + universe: + $ref: '#/components/schemas/OneOfQuantUniverse' + dates: + $ref: '#/components/schemas/OneOfQuantDates' + formulas: + items: + $ref: '#/components/schemas/OneOfQuantFormulas' + type: array + jobDescription: + type: string type: object - UnlinkedPATemplateSummary: + QuantCalculationMeta: example: - name: name - description: description - category: category + contentorganization: SimplifiedRow + allowArrayData: true + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: - description: - description: Template description. + allowArrayData: + type: boolean + contentorganization: + default: SimplifiedRow + deprecated: true + enum: + - None + - Row + - Column + - SimplifiedRow type: string - name: - description: Template name. + stachContentOrganization: + default: SimplifiedRow + enum: + - None + - Row + - Column + - SimplifiedRow type: string - category: - description: Unlinked template category + contenttype: + default: Json + deprecated: true + enum: + - Json + - Binary + type: string + format: + default: JsonStach + enum: + - JsonStach + - Table + - Tableau + - BinaryStach + - Bison + - Binary + - Pdf + - Pptx + - Feather type: string type: object - UnlinkedPATemplateSummaryRoot: + QuantCalculationParametersRoot: example: data: key: - name: name - description: description - category: category - meta: '{}' + formulas: + - null + - null + jobDescription: jobDescription + meta: + contentorganization: SimplifiedRow + allowArrayData: true + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: data: additionalProperties: - $ref: '#/components/schemas/UnlinkedPATemplateSummary' + $ref: '#/components/schemas/QuantCalculationParameters' + description: List of calculation parameters. type: object meta: - type: object - required: - - data + $ref: '#/components/schemas/QuantCalculationMeta' type: object - UnlinkedPATemplateUpdateParameters: + SPARDateParameters: + description: The date parameters for SPAR calculation. example: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - description: description - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory + enddate: enddate + startdate: startdate + useeachportfolioinception: true + frequency: frequency properties: - description: - description: Template description + startdate: + description: Calculation's start date. type: string - accounts: - description: List of accounts - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - columns: - description: List of columns for the PA calculation - items: - $ref: '#/components/schemas/PACalculationColumn' - type: array - dates: - $ref: '#/components/schemas/PADateParameters' - groups: - description: List of groupings for the PA calculation - items: - $ref: '#/components/schemas/PACalculationGroup' - type: array - datasources: - $ref: '#/components/schemas/PACalculationDataSources' - currencyisocode: - description: Currency ISO code for calculation. + enddate: + description: Calculation's end date. type: string - componentdetail: - description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or - SECURITIES. + frequency: + description: Calculation's frequency. type: string - content: - $ref: '#/components/schemas/TemplateContentTypes' - type: object - UnlinkedPATemplateUpdateParametersRoot: - example: - data: - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - description: description - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory - meta: '{}' - properties: - data: - $ref: '#/components/schemas/UnlinkedPATemplateUpdateParameters' - meta: - type: object + useeachportfolioinception: + description: Use Each Portfolio Inception + type: boolean required: - - data + - enddate + - frequency + - startdate type: object - UnlinkedPATemplate: + SPARCalculationParameters: example: - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - description: description + currencyisocode: currencyisocode + componentid: componentid dates: enddate: enddate startdate: startdate + useeachportfolioinception: true frequency: frequency - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory - templateTypeId: templateTypeId - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - name: name - id: id accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - category: category - snapshot: true + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype + id: id properties: - id: - description: Template id. - type: string - directory: - description: Template directory. - type: string - templateTypeId: - description: Template type id + componentid: + description: The SPAR Engine component identifier to analyze. type: string - snapshot: - description: snapshot. - type: boolean accounts: - description: List of accounts - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - benchmarks: - description: List of benchmarks - items: - $ref: '#/components/schemas/PAIdentifier' - type: array - columns: - description: List of columns for the PA calculation + description: List of accounts for SPAR calculation. items: - $ref: '#/components/schemas/PACalculationColumn' + $ref: '#/components/schemas/SPARIdentifier' type: array + benchmark: + $ref: '#/components/schemas/SPARIdentifier' dates: - $ref: '#/components/schemas/PADateParameters' - groups: - description: List of groupings for the PA calculation - items: - $ref: '#/components/schemas/PACalculationGroup' - type: array - datasources: - $ref: '#/components/schemas/PACalculationDataSources' + $ref: '#/components/schemas/SPARDateParameters' currencyisocode: description: Currency ISO code for calculation. type: string - componentdetail: - description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or - SECURITIES. - type: string - content: - $ref: '#/components/schemas/TemplateContentTypes' - description: - description: Template description. - type: string - name: - description: Template name. - type: string - category: - description: Unlinked template category - type: string - type: object - UnlinkedPATemplateRoot: - example: - data: - columns: - - id: id - statistics: - - statistics - - statistics - - id: id - statistics: - - statistics - - statistics - groups: - - id: id - frequency: frequency - - id: id - frequency: frequency - description: description - dates: - enddate: enddate - startdate: startdate - frequency: frequency - directory: directory - content: - optional: - - optional - - optional - locked: - - locked - - locked - mandatory: - - mandatory - - mandatory - templateTypeId: templateTypeId - currencyisocode: currencyisocode - componentdetail: componentdetail - datasources: - benchmarkpricingsources: - - id: id - - id: id - useportfoliopricingsourcesforbenchmark: true - portfoliopricingsources: - - id: id - - id: id - name: name - id: id - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - category: category - snapshot: true - meta: '{}' - properties: - data: - $ref: '#/components/schemas/UnlinkedPATemplate' - meta: - type: object required: - - data - type: object - UnlinkedPATemplateCategoryAndType: - example: - name: name - category: category - properties: - category: - description: Unlinked template category - type: string - name: - description: Unlinked template type - type: string + - componentid type: object - UnlinkedPATemplateCategoryAndTypeRoot: + SPARCalculationParametersRoot: example: data: key: - name: name - category: category - meta: '{}' + currencyisocode: currencyisocode + componentid: componentid + dates: + enddate: enddate + startdate: startdate + useeachportfolioinception: true + frequency: frequency + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype + id: id + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: data: additionalProperties: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndType' + $ref: '#/components/schemas/SPARCalculationParameters' + description: List of calculation parameters. type: object meta: - type: object - required: - - data - type: object - UnlinkedPATemplateColumnDetails: - example: - name: name - id: id - statistics: - - statistics - - statistics - properties: - name: - description: Unlinked template column name - type: string - id: - description: FactSet-defined or User-defined Column identifier. - type: string - statistics: - description: Column Statistic identifier - items: - type: string - type: array - type: object - UnlinkedPATemplateGroupDetails: - example: - name: name - id: id - frequency: frequency - properties: - name: - description: Unlinked template group name - type: string - id: - description: FactSet-defined or User-defined Group identifier. - type: string - frequency: - description: Grouping frequency - type: string + $ref: '#/components/schemas/CalculationMeta' type: object - UnlinkedPATemplateCategoryAndTypeDetails: + VaultAttributionLoaderResponse: example: - columns: - - name: name - id: id - statistics: - - statistics - - statistics - - name: name - id: id - statistics: - - statistics - - statistics - name: name - groups: - - name: name - id: id - frequency: frequency - - name: name - id: id - frequency: frequency - id: id - category: category - snapshot: true + processId: processId + groupId: groupId + objectId: objectId properties: - id: - description: Type Id + processId: + description: ProcessId. type: string - columns: - description: List of default columns - items: - $ref: '#/components/schemas/UnlinkedPATemplateColumnDetails' - type: array - groups: - description: List of default groupings - items: - $ref: '#/components/schemas/UnlinkedPATemplateGroupDetails' - type: array - snapshot: - description: Snapshot - type: boolean - category: - description: Unlinked template category + groupId: + description: GroupId. type: string - name: - description: Unlinked template type + objectId: + description: ObjectId. type: string type: object - UnlinkedPATemplateCategoryAndTypeDetailsRoot: + VaultAttributionLoaderResponseRoot: example: data: - columns: - - name: name - id: id - statistics: - - statistics - - statistics - - name: name - id: id - statistics: - - statistics - - statistics - name: name - groups: - - name: name - id: id - frequency: frequency - - name: name - id: id - frequency: frequency - id: id - category: category - snapshot: true + processId: processId + groupId: groupId + objectId: objectId meta: '{}' properties: data: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails' + $ref: '#/components/schemas/VaultAttributionLoaderResponse' meta: type: object required: @@ -45630,6 +30785,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/build.gradle b/auto-generated-sdk/build.gradle index ca12eb00..97f6352e 100644 --- a/auto-generated-sdk/build.gradle +++ b/auto-generated-sdk/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'idea' apply plugin: 'eclipse' group = 'com.factset.analyticsapi' -version = '6.2.0' +version = '6.3.0-rc.1' buildscript { repositories { diff --git a/auto-generated-sdk/build.sbt b/auto-generated-sdk/build.sbt index 104f22e6..17a24e93 100644 --- a/auto-generated-sdk/build.sbt +++ b/auto-generated-sdk/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.factset.analyticsapi", name := "engines-sdk", - version := "6.2.0", + version := "6.3.0-rc.1", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/auto-generated-sdk/docs/AccountDirectories.md b/auto-generated-sdk/docs/AccountDirectories.md index e5acfb04..76f04c90 100644 --- a/auto-generated-sdk/docs/AccountDirectories.md +++ b/auto-generated-sdk/docs/AccountDirectories.md @@ -2,6 +2,7 @@ # AccountDirectories +List of the accounts and directories. ## Properties diff --git a/auto-generated-sdk/docs/CalculationStatus.md b/auto-generated-sdk/docs/CalculationStatus.md index bde2407b..0a173c64 100644 --- a/auto-generated-sdk/docs/CalculationStatus.md +++ b/auto-generated-sdk/docs/CalculationStatus.md @@ -2,6 +2,7 @@ # CalculationStatus +Details of the calculation. ## Properties diff --git a/auto-generated-sdk/docs/CalculationStatusMeta.md b/auto-generated-sdk/docs/CalculationStatusMeta.md index c53e9b8f..b257831d 100644 --- a/auto-generated-sdk/docs/CalculationStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationStatusMeta.md @@ -2,12 +2,13 @@ # CalculationStatusMeta +Meta of calculation units in batch. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**units** | [**Map<String, CalculationUnitStatusMeta>**](CalculationUnitStatusMeta.md) | Meta of calculation units in batch. | [optional] +**units** | [**Map<String, CalculationUnitStatusMeta>**](CalculationUnitStatusMeta.md) | List of calculation units in batch. | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index bdb23f1b..03346392 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -2,6 +2,7 @@ # CalculationUnitStatus +The status of the calculation as per FactSets API standards ## Properties diff --git a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md index cb98ad77..5ca0a7e7 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md @@ -2,6 +2,7 @@ # CalculationUnitStatusMeta +Meta of the calculation unit. ## Properties diff --git a/auto-generated-sdk/docs/Column.md b/auto-generated-sdk/docs/Column.md deleted file mode 100644 index ce244f69..00000000 --- a/auto-generated-sdk/docs/Column.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# Column - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**defaultstatisticsids** | **java.util.List<String>** | Column statistic Id | [optional] -**name** | **String** | Column Name | [optional] -**directory** | **String** | Column Directory | [optional] -**category** | **String** | Column Category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/ColumnRoot.md b/auto-generated-sdk/docs/ColumnRoot.md deleted file mode 100644 index ee5ed73f..00000000 --- a/auto-generated-sdk/docs/ColumnRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# ColumnRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Column**](Column.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/ColumnStatistic.md b/auto-generated-sdk/docs/ColumnStatistic.md deleted file mode 100644 index 84b24998..00000000 --- a/auto-generated-sdk/docs/ColumnStatistic.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# ColumnStatistic - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Column Statistic Name | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/ColumnStatisticRoot.md b/auto-generated-sdk/docs/ColumnStatisticRoot.md deleted file mode 100644 index db736da9..00000000 --- a/auto-generated-sdk/docs/ColumnStatisticRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# ColumnStatisticRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, ColumnStatistic>**](ColumnStatistic.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/ColumnSummary.md b/auto-generated-sdk/docs/ColumnSummary.md deleted file mode 100644 index 7c52dab2..00000000 --- a/auto-generated-sdk/docs/ColumnSummary.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# ColumnSummary - -Column settings (name, directory, category) - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Column Name | [optional] -**directory** | **String** | Column Directory | [optional] -**category** | **String** | Column Category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md deleted file mode 100644 index 29a80a14..00000000 --- a/auto-generated-sdk/docs/ColumnsApi.md +++ /dev/null @@ -1,179 +0,0 @@ - -# ColumnsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getPAColumnById**](ColumnsApi.md#getPAColumnById) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings -[**getPAColumns**](ColumnsApi.md#getPAColumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns - - - -## getPAColumnById - -> ColumnRoot getPAColumnById(id) - -Get PA column settings - -This endpoint returns the default settings of a PA column. - -### 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.ColumnsApi; - -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"); - - ColumnsApi apiInstance = new ColumnsApi(defaultClient); - String id = "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7"; // String | Unique identifier for a column - try { - ColumnRoot result = apiInstance.getPAColumnById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ColumnsApi#getPAColumnById"); - 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**| Unique identifier for a column | - -### Return type - -[**ColumnRoot**](ColumnRoot.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 settings of a PA column. | * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. | * 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** | Column 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.
| - - -## getPAColumns - -> ColumnSummaryRoot getPAColumns(name, category, directory) - -Get PA columns - -This endpoint lists all the PA columns that can be applied to 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.ColumnsApi; - -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"); - - ColumnsApi apiInstance = new ColumnsApi(defaultClient); - String name = ""; // String | Column name - String category = ""; // String | Column category - String directory = ""; // String | The directory to get the columns in - try { - ColumnSummaryRoot result = apiInstance.getPAColumns(name, category, directory); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ColumnsApi#getPAColumns"); - 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 -------------- | ------------- | ------------- | ------------- - **name** | **String**| Column name | [optional] [default to ] - **category** | **String**| Column category | [optional] [default to ] - **directory** | **String**| The directory to get the columns in | [optional] [default to ] - -### Return type - -[**ColumnSummaryRoot**](ColumnSummaryRoot.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 PA columns | * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index c8b42022..7956eb0b 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -5,8 +5,6 @@ All URIs are relative to *https://api.factset.com* 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 [**getSPARComponentById**](ComponentsApi.md#getSPARComponentById) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id [**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 @@ -14,172 +12,6 @@ Method | HTTP request | Description -## getPAComponentById - -> PAComponentRoot getPAComponentById(id) - -Get PA component by id - -This endpoint returns the default settings of a PA component. - -### 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 id = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Unique identifier for a PA component - try { - PAComponentRoot result = apiInstance.getPAComponentById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ComponentsApi#getPAComponentById"); - 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**| Unique identifier for a PA component | - -### Return type - -[**PAComponentRoot**](PAComponentRoot.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 default settings of a PA component. | * 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 PA component id. | * 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** | Component 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.
| - - -## getPAComponents - -> ComponentSummaryRoot getPAComponents(document) - -Get PA components - -This endpoint returns the list of PA components in a given PA 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 = "PA3_DOCUMENTS:DEFAULT"; // String | Document Name - try { - ComponentSummaryRoot result = apiInstance.getPAComponents(document); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ComponentsApi#getPAComponents"); - 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 PA 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 PA 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** | 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.
| - - ## getSPARComponentById > SPARComponentRoot getSPARComponentById(id) @@ -380,7 +212,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ComponentsApi apiInstance = new ComponentsApi(defaultClient); - String id = "id_example"; // String | Unique identifier for a vault component + String id = "AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D"; // String | Unique identifier for a vault component try { VaultComponentRoot result = apiInstance.getVaultComponentById(id); System.out.println(result); @@ -463,7 +295,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ComponentsApi apiInstance = new ComponentsApi(defaultClient); - String document = "document_example"; // String | Document Name + String document = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT"; // String | Document Name try { ComponentSummaryRoot result = apiInstance.getVaultComponents(document); System.out.println(result); diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index b52d6293..6a1d5a47 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -44,7 +44,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); - String id = "id_example"; // String | Vault configuration id to get the details of + String id = "e95ef921-b4d4-4bb7-93ba-60eca8e3247a"; // String | Vault configuration id to get the details of try { VaultConfigurationRoot result = apiInstance.getVaultConfigurationById(id); System.out.println(result); @@ -127,7 +127,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); - String account = "account_example"; // String | Required account query parameter to filter configurations for a specific account + String account = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT"; // String | Required account query parameter to filter configurations for a specific account try { VaultConfigurationSummaryRoot result = apiInstance.getVaultConfigurations(account); System.out.println(result); diff --git a/auto-generated-sdk/docs/Currency.md b/auto-generated-sdk/docs/Currency.md index c9f91057..beb4b550 100644 --- a/auto-generated-sdk/docs/Currency.md +++ b/auto-generated-sdk/docs/Currency.md @@ -2,6 +2,7 @@ # Currency +Details of the currency. ## Properties diff --git a/auto-generated-sdk/docs/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md index 95a53ec2..3757dca7 100644 --- a/auto-generated-sdk/docs/DatesApi.md +++ b/auto-generated-sdk/docs/DatesApi.md @@ -5,100 +5,10 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**convertPADatesToAbsoluteFormat**](DatesApi.md#convertPADatesToAbsoluteFormat) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format [**convertVaultDatesToAbsoluteFormat**](DatesApi.md#convertVaultDatesToAbsoluteFormat) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format -## convertPADatesToAbsoluteFormat - -> DateParametersSummaryRoot convertPADatesToAbsoluteFormat(enddate, componentid, account, startdate) - -Convert PA dates to absolute format - -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. - -### 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.DatesApi; - -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"); - - DatesApi apiInstance = new DatesApi(defaultClient); - String enddate = "-1AY"; // String | End Date - String componentid = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Component Id - String account = "Client:/Folder1/Folder2/AccountName.ACCT"; // String | Account ( Account Name ending with .ACCT or .ACTM ) - String startdate = "-3AY"; // String | Start Date - try { - DateParametersSummaryRoot result = apiInstance.convertPADatesToAbsoluteFormat(enddate, componentid, account, startdate); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DatesApi#convertPADatesToAbsoluteFormat"); - 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 -------------- | ------------- | ------------- | ------------- - **enddate** | **String**| End Date | - **componentid** | **String**| Component Id | - **account** | **String**| Account ( Account Name ending with .ACCT or .ACTM ) | - **startdate** | **String**| Start Date | [optional] - -### Return type - -[**DateParametersSummaryRoot**](DateParametersSummaryRoot.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 converted dates in yyyymmdd format. | * 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 is 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** | Document or 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.
| - - ## convertVaultDatesToAbsoluteFormat > DateParametersSummaryRoot convertVaultDatesToAbsoluteFormat(enddate, componentid, account, startdate) diff --git a/auto-generated-sdk/docs/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md index ddf6de1b..dd03bb06 100644 --- a/auto-generated-sdk/docs/DocumentsApi.md +++ b/auto-generated-sdk/docs/DocumentsApi.md @@ -5,96 +5,12 @@ All URIs are relative to *https://api.factset.com* 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 -## getPA3Documents - -> DocumentDirectoriesRoot getPA3Documents(path) - -Get PA3 documents and sub-directories in a directory - -This endpoint looks up all PA3 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 = "Client:"; // String | The directory to get the documents and sub-directories in - try { - DocumentDirectoriesRoot result = apiInstance.getPA3Documents(path); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DocumentsApi#getPA3Documents"); - 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 and sub-directories in | - -### 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 PA3 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.
| - - ## getPubDocuments > DocumentDirectoriesRoot getPubDocuments(path) diff --git a/auto-generated-sdk/docs/FIConvertibleSettings.md b/auto-generated-sdk/docs/FIConvertibleSettings.md new file mode 100644 index 00000000..8ea9c4a7 --- /dev/null +++ b/auto-generated-sdk/docs/FIConvertibleSettings.md @@ -0,0 +1,32 @@ + + +# FIConvertibleSettings + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**equityPrice** | **Double** | Equity Price | [optional] +**equityIndexVolatility** | **Double** | Equity Index Volatility | [optional] +**equityDividendYield** | **Double** | Equity Dividend Yield | [optional] +**volatilityCapMethod** | [**VolatilityCapMethodEnum**](#VolatilityCapMethodEnum) | Volatility CapMethod | [optional] +**volatilityCapMethodValue** | **Double** | Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) | [optional] +**equityExchangeRate** | **Double** | Equity Exchange Rate | [optional] + + + +## Enum: VolatilityCapMethodEnum + +Name | Value +---- | ----- +NOCAP | "noCap" +SPECIFIEDRATE | "specifiedRate" +MULTIPLIER | "multiplier" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index 2f3695fb..8690f983 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **matrixMultiplier** | **Double** | Matrix Multiplier | [optional] **structuredProducts** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] **attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] +**convertible** | [**FIConvertibleSettings**](FIConvertibleSettings.md) | | [optional] **calcFromMethod** | **String** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] **calcFromValue** | **Double** | Calculation from value | **face** | **Double** | Face | [optional] diff --git a/auto-generated-sdk/docs/FPOAccount.md b/auto-generated-sdk/docs/FPOAccount.md deleted file mode 100644 index 9b05baf9..00000000 --- a/auto-generated-sdk/docs/FPOAccount.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# FPOAccount - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paDocument** | [**PaDoc**](PaDoc.md) | | -**id** | **String** | Account path | [optional] -**overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FPOObjective.md b/auto-generated-sdk/docs/FPOObjective.md deleted file mode 100644 index 24143e54..00000000 --- a/auto-generated-sdk/docs/FPOObjective.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# FPOObjective - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active** | **String** | | [optional] -**terms** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | | [optional] - - - -## Enum: java.util.Map<String, InnerEnum> - -Name | Value ----- | ----- -DISABLE | "Disable" -ENABLE | "Enable" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FPOOptimizationParameters.md b/auto-generated-sdk/docs/FPOOptimizationParameters.md deleted file mode 100644 index 27f06e93..00000000 --- a/auto-generated-sdk/docs/FPOOptimizationParameters.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# FPOOptimizationParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account** | [**FPOAccount**](FPOAccount.md) | | [optional] -**strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | -**optimization** | [**Optimization**](Optimization.md) | | [optional] -**outputTypes** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md deleted file mode 100644 index 564822d0..00000000 --- a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# FPOOptimizationParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**FPOOptimizationParameters**](FPOOptimizationParameters.md) | | [optional] -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategy.md b/auto-generated-sdk/docs/FPOOptimizerStrategy.md deleted file mode 100644 index 1ad0218d..00000000 --- a/auto-generated-sdk/docs/FPOOptimizerStrategy.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# FPOOptimizerStrategy - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] -**id** | **String** | OptimizerStrategy document path | - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md deleted file mode 100644 index 74b1557a..00000000 --- a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# FPOOptimizerStrategyOverrides - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**objective** | [**FPOObjective**](FPOObjective.md) | | [optional] -**constraints** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | List of constraints | [optional] -**alpha** | **String** | Alpha | [optional] -**transactionCost** | **String** | Transaction cost | [optional] - - - -## Enum: java.util.Map<String, InnerEnum> - -Name | Value ----- | ----- -DISABLE | "Disable" -ENABLE | "Enable" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FiCalculationsApi.md b/auto-generated-sdk/docs/FiCalculationsApi.md index 410f3763..e12a01cd 100644 --- a/auto-generated-sdk/docs/FiCalculationsApi.md +++ b/auto-generated-sdk/docs/FiCalculationsApi.md @@ -80,7 +80,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: text/plain, application/json, text/json +- **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/FpoOptimizerApi.md b/auto-generated-sdk/docs/FpoOptimizerApi.md deleted file mode 100644 index 74852448..00000000 --- a/auto-generated-sdk/docs/FpoOptimizerApi.md +++ /dev/null @@ -1,527 +0,0 @@ - -# FpoOptimizerApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelOptimizationById**](FpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id -[**getOptimizationParameters**](FpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id -[**getOptimizationResult**](FpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id -[**getOptimizationStatusById**](FpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id -[**postAndOptimize**](FpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization -[**putAndOptimize**](FpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. - - - -## cancelOptimizationById - -> cancelOptimizationById(id) - -Cancel FPO optimization by id - -This is the endpoint to cancel a previously submitted optimization. - -### 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint - try { - apiInstance.cancelOptimizationById(id); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#cancelOptimizationById"); - 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 FPO optimization 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, optimization 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 optimization 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.
| - - -## getOptimizationParameters - -> FPOOptimizationParametersRoot getOptimizationParameters(id) - -Get FPO optimization parameters by id - -This is the endpoint that returns the optimization parameters passed for an optimization. - -### 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint - try { - FPOOptimizationParametersRoot result = apiInstance.getOptimizationParameters(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#getOptimizationParameters"); - 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 FPO optimization endpoint | - -### Return type - -[**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.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 FPO optimization 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** | Optimization 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.
| - - -## getOptimizationResult - -> ObjectRoot getOptimizationResult(id, accept) - -Get FPO optimization result by id - -This is the endpoint to get the result of a previously requested optimization. -If the optimization has finished computing, the body of the response will contain result 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Get FPO optimization status by id endpoint - String accept = "accept_example"; // String | Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * - try { - ObjectRoot result = apiInstance.getOptimizationResult(id, accept); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#getOptimizationResult"); - 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 FPO optimization status by id endpoint | - **accept** | **String**| Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * | [optional] - -### Return type - -[**ObjectRoot**](ObjectRoot.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 optimization is completed, returns JSON. | * 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** | Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
| - - -## getOptimizationStatusById - -> ObjectRoot getOptimizationStatusById(id) - -Get FPO optimization status by id - -This is the endpoint to check on the progress of a previously requested optimization. -If the optimization has finished computing, the body of the response will contain result in JSON. -Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - -### 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint - try { - Object result = apiInstance.getOptimizationStatusById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#getOptimizationStatusById"); - 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 FPO optimization endpoint | - -### Return type - -(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - null (empty response body) ) - -### 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 | -|-------------|-------------|------------------| -| **201** | Expected response once optimization is completed, returns 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.
| -| **202** | Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * 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** | Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
| - - -## postAndOptimize - -> ObjectRoot postAndOptimize(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot) - -Create and Run FPO optimization - -This endpoint runs FPO optimization specified in the POST body parameters. - -Remarks: - -* Any settings in POST body will act as a one-time override over the settings saved in the strategy 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. - String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. - FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters - try { - Object result = apiInstance.postAndOptimize(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#postAndOptimize"); - 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. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] - **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] - -### Return type - -(For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.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 - -### 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 optimization
* 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, returns json if optimization is completed in a short span. | * 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 optimization 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 optimization 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 optimization 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.
| - - -## putAndOptimize - -> ObjectRoot putAndOptimize(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot) - -Create or Update FPO optimization and run it. - -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. - -### 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.FpoOptimizerApi; - -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"); - - FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint - Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. - String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. - FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters - try { - Object result = apiInstance.putAndOptimize(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FpoOptimizerApi#putAndOptimize"); - 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 FPO optimization endpoint | - **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] - **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] - -### Return type - -(For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.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 - -### 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 optimization
* 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, returns json if optimization is completed in a short span. | * 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 Optimization 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 optimization 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 optimization 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 optimization 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/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md index 3a93493a..f26d622a 100644 --- a/auto-generated-sdk/docs/FrequenciesApi.md +++ b/auto-generated-sdk/docs/FrequenciesApi.md @@ -5,89 +5,11 @@ 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 -## getPAFrequencies - -> FrequencyRoot getPAFrequencies() - -Get PA frequencies - -This endpoint lists all the frequencies that can be applied to a PA 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.getPAFrequencies(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FrequenciesApi#getPAFrequencies"); - 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 PA 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.
| - - ## getSPARFrequencies > FrequencyRoot getSPARFrequencies() diff --git a/auto-generated-sdk/docs/Group.md b/auto-generated-sdk/docs/Group.md deleted file mode 100644 index 58529bbf..00000000 --- a/auto-generated-sdk/docs/Group.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Group - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Group Name | [optional] -**directory** | **String** | Group Directory | [optional] -**category** | **String** | Group Category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/GroupRoot.md b/auto-generated-sdk/docs/GroupRoot.md deleted file mode 100644 index cf84e286..00000000 --- a/auto-generated-sdk/docs/GroupRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# GroupRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, Group>**](Group.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/GroupsApi.md b/auto-generated-sdk/docs/GroupsApi.md deleted file mode 100644 index 6e135ada..00000000 --- a/auto-generated-sdk/docs/GroupsApi.md +++ /dev/null @@ -1,165 +0,0 @@ - -# GroupsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getPAGroupingFrequencies**](GroupsApi.md#getPAGroupingFrequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies -[**getPAGroups**](GroupsApi.md#getPAGroups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups - - - -## getPAGroupingFrequencies - -> FrequencyRoot getPAGroupingFrequencies() - -Get PA grouping frequencies - -This endpoint lists all the PA grouping frequencies that can be applied to a PA 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.GroupsApi; - -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"); - - GroupsApi apiInstance = new GroupsApi(defaultClient); - try { - FrequencyRoot result = apiInstance.getPAGroupingFrequencies(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling GroupsApi#getPAGroupingFrequencies"); - 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 PA grouping 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.
| - - -## getPAGroups - -> GroupRoot getPAGroups() - -Get PA groups - -This endpoint lists all the PA groups that can be applied to a PA 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.GroupsApi; - -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"); - - GroupsApi apiInstance = new GroupsApi(defaultClient); - try { - GroupRoot result = apiInstance.getPAGroups(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling GroupsApi#getPAGroups"); - 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 - -[**GroupRoot**](GroupRoot.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 PA groups | * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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/LinkedPATemplate.md b/auto-generated-sdk/docs/LinkedPATemplate.md deleted file mode 100644 index fe80a3c2..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplate.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# LinkedPATemplate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **String** | Template directory. | [optional] -**snapshot** | **Boolean** | snapshot. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] -**id** | **String** | Template id. | [optional] -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**parentComponentId** | **String** | Template parent tile. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateParameters.md deleted file mode 100644 index c4049aa8..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateParameters.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# LinkedPATemplateParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **String** | The directory to create a linked PA template | -**parentComponentId** | **String** | Parent component id | -**description** | **String** | Template description | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md deleted file mode 100644 index 498eb6db..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# LinkedPATemplateParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md deleted file mode 100644 index 516b8a6f..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# LinkedPATemplatePostSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Template id. | [optional] -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**parentComponentId** | **String** | Template parent tile. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md deleted file mode 100644 index ab14f6c4..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# LinkedPATemplatePostSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateRoot.md b/auto-generated-sdk/docs/LinkedPATemplateRoot.md deleted file mode 100644 index f9cac34a..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# LinkedPATemplateRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummary.md b/auto-generated-sdk/docs/LinkedPATemplateSummary.md deleted file mode 100644 index 8e95e61f..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateSummary.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# LinkedPATemplateSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**parentComponentId** | **String** | Template parent tile. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md deleted file mode 100644 index a75c2ba8..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# LinkedPATemplateSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, LinkedPATemplateSummary>**](LinkedPATemplateSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md deleted file mode 100644 index 61862c91..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# LinkedPATemplateUpdateParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parentComponentId** | **String** | Parent component id | [optional] -**description** | **String** | Template description | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md deleted file mode 100644 index b0fdc1fb..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# LinkedPATemplateUpdateParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md deleted file mode 100644 index 38d7bbe5..00000000 --- a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md +++ /dev/null @@ -1,460 +0,0 @@ - -# LinkedPaTemplatesApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createLinkedPATemplates**](LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template -[**deleteLinkedPATemplates**](LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. -[**getLinkedPATemplates**](LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates -[**getLinkedPATemplatesById**](LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id -[**updateLinkedPATemplates**](LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template - - - -## createLinkedPATemplates - -> LinkedPATemplatePostSummaryRoot createLinkedPATemplates(linkedPATemplateParametersRoot) - -Create a linked PA template - -This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. - -Remarks: - -* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. - If no mandatory fields are passed, then we can use the template as a component and skip the component creation. - -* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". - -* We cannot override the Locked fields when creating the Component. - -* Mandatory and locked strings are mutually exclusive. - -* Multi-horizon frequencies are not supported through this endpoint. - -### 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.LinkedPaTemplatesApi; - -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"); - - LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); - LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = new LinkedPATemplateParametersRoot(); // LinkedPATemplateParametersRoot | Request Parameters - try { - LinkedPATemplatePostSummaryRoot result = apiInstance.createLinkedPATemplates(linkedPATemplateParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling LinkedPaTemplatesApi#createLinkedPATemplates"); - 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 -------------- | ------------- | ------------- | ------------- - **linkedPATemplateParametersRoot** | [**LinkedPATemplateParametersRoot**](LinkedPATemplateParametersRoot.md)| Request Parameters | - -### Return type - -[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.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 | -|-------------|-------------|------------------| -| **201** | Expected response, created a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| -| **404** | Component 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.
| -| **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.
| - - -## deleteLinkedPATemplates - -> deleteLinkedPATemplates(id) - -Delete a linked PA template. - -This endpoint deletes an existing linked PA 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.LinkedPaTemplatesApi; - -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"); - - LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template - try { - apiInstance.deleteLinkedPATemplates(id); - } catch (ApiException e) { - System.err.println("Exception when calling LinkedPaTemplatesApi#deleteLinkedPATemplates"); - 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**| Unique identifier for a linked PA template | - -### 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, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. | * 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.
| - - -## getLinkedPATemplates - -> LinkedPATemplateSummaryRoot getLinkedPATemplates(directory, documentDirectory, documentName) - -Get linked PA templates - -This endpoint returns the list of linked PA templates in given path. - -### 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.LinkedPaTemplatesApi; - -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"); - - LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); - 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 { - LinkedPATemplateSummaryRoot result = apiInstance.getLinkedPATemplates(directory, documentDirectory, documentName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplates"); - 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 -------------- | ------------- | ------------- | ------------- - **directory** | **String**| Get linked PA templates in path. | [optional] - **documentDirectory** | **String**| Get linked PA templates for documents in document path | [optional] - **documentName** | **String**| Get linked PA templates for documents by document name | [optional] - -### Return type - -[**LinkedPATemplateSummaryRoot**](LinkedPATemplateSummaryRoot.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 templates linked to PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | 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.
| - - -## getLinkedPATemplatesById - -> LinkedPATemplateRoot getLinkedPATemplatesById(id) - -Get linked PA template by id - -This endpoint fetches the linked PA template settings. - -### 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.LinkedPaTemplatesApi; - -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"); - - LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template - try { - LinkedPATemplateRoot result = apiInstance.getLinkedPATemplatesById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplatesById"); - 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**| Unique identifier for a linked PA template | - -### Return type - -[**LinkedPATemplateRoot**](LinkedPATemplateRoot.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, linked PA template details. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| - - -## updateLinkedPATemplates - -> LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot) - -Update a linked PA template - -This endpoint allows the user to change the request body and description from an existing template. - -Remarks: - -* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. - If no mandatory fields are passed, then we can use the template as a component and skip the component creation. - -* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". - -* We cannot override the Locked fields when creating the Component. - -* Mandatory and locked strings are mutually exclusive. - -* Multi-horizon frequencies are not supported through this endpoint. - -### 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.LinkedPaTemplatesApi; - -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"); - - LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); - 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); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling LinkedPaTemplatesApi#updateLinkedPATemplates"); - 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**| Unique identifier for a linked PA template | - **linkedPATemplateUpdateParametersRoot** | [**LinkedPATemplateUpdateParametersRoot**](LinkedPATemplateUpdateParametersRoot.md)| Request Parameters | - -### Return type - -[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.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, updated a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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 or component 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/PACalculationColumn.md b/auto-generated-sdk/docs/PACalculationColumn.md deleted file mode 100644 index 7fe7461d..00000000 --- a/auto-generated-sdk/docs/PACalculationColumn.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACalculationColumn - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | FactSet-defined or User-defined Column identifier. | [optional] -**statistics** | **java.util.List<String>** | Column Statistic identifier | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACalculationDataSources.md b/auto-generated-sdk/docs/PACalculationDataSources.md deleted file mode 100644 index 96549eae..00000000 --- a/auto-generated-sdk/docs/PACalculationDataSources.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# PACalculationDataSources - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**portfoliopricingsources** | [**java.util.List<PACalculationPricingSource>**](PACalculationPricingSource.md) | List of portfilio pricing source for the PA calculation | [optional] -**benchmarkpricingsources** | [**java.util.List<PACalculationPricingSource>**](PACalculationPricingSource.md) | List of benchmark pricing source for the PA calculation | [optional] -**useportfoliopricingsourcesforbenchmark** | **Boolean** | Use portfolio pricing sources for benchmark | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACalculationGroup.md b/auto-generated-sdk/docs/PACalculationGroup.md deleted file mode 100644 index c1a2297a..00000000 --- a/auto-generated-sdk/docs/PACalculationGroup.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACalculationGroup - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | FactSet-defined or User-defined Group identifier. | [optional] -**frequency** | **String** | Grouping frequency | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md deleted file mode 100644 index 35dfd1e6..00000000 --- a/auto-generated-sdk/docs/PACalculationParameters.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# PACalculationParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**componentid** | **String** | The PA Engine component identifier to analyze. | -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts. | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks. | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] -**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] -**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**componentdetail** | **String** | Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACalculationParametersRoot.md b/auto-generated-sdk/docs/PACalculationParametersRoot.md deleted file mode 100644 index ce6d7e1b..00000000 --- a/auto-generated-sdk/docs/PACalculationParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACalculationParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, PACalculationParameters>**](PACalculationParameters.md) | List of calculation parameters. | [optional] -**meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACalculationPricingSource.md b/auto-generated-sdk/docs/PACalculationPricingSource.md deleted file mode 100644 index b196e20e..00000000 --- a/auto-generated-sdk/docs/PACalculationPricingSource.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# PACalculationPricingSource - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Pricing source identifier | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md deleted file mode 100644 index df989d29..00000000 --- a/auto-generated-sdk/docs/PAComponent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# PAComponent - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Component identifier. | [optional] -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] -**currencyisocode** | **String** | | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**snapshot** | **Boolean** | Is the component type snapshot or subperiod. | [optional] -**path** | **String** | The path to the document | [optional] -**name** | **String** | Component name. | [optional] -**category** | **String** | Component category. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md deleted file mode 100644 index 45f35d8e..00000000 --- a/auto-generated-sdk/docs/PAComponentData.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# PAComponentData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts. | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks. | [optional] -**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] -**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] -**componentdetail** | **String** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAComponentRoot.md b/auto-generated-sdk/docs/PAComponentRoot.md deleted file mode 100644 index 84e31c05..00000000 --- a/auto-generated-sdk/docs/PAComponentRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PAComponentRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PAComponent**](PAComponent.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PADateParameters.md b/auto-generated-sdk/docs/PADateParameters.md deleted file mode 100644 index c73a5013..00000000 --- a/auto-generated-sdk/docs/PADateParameters.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# PADateParameters - -The date parameters for PA calculation. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**startdate** | **String** | Calculation's start date. | [optional] -**enddate** | **String** | Calculation's end date. | -**frequency** | **String** | Calculation's frequency. | - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAIdentifier.md b/auto-generated-sdk/docs/PAIdentifier.md deleted file mode 100644 index fc5a1c10..00000000 --- a/auto-generated-sdk/docs/PAIdentifier.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PAIdentifier - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | User's FactSet account path OR benchmark. | -**holdingsmode** | **String** | Holdings Mode can be B&H, TBR, OMS , EXT or VLT. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAPricingSource.md b/auto-generated-sdk/docs/PAPricingSource.md deleted file mode 100644 index 7fb89d43..00000000 --- a/auto-generated-sdk/docs/PAPricingSource.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# PAPricingSource - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Pricing source Name | [optional] -**directory** | **String** | Pricing source directory | [optional] -**category** | **String** | Pricing source category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PAPricingSourceRoot.md b/auto-generated-sdk/docs/PAPricingSourceRoot.md deleted file mode 100644 index df400d3f..00000000 --- a/auto-generated-sdk/docs/PAPricingSourceRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PAPricingSourceRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, PAPricingSource>**](PAPricingSource.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PaCalculationsApi.md b/auto-generated-sdk/docs/PaCalculationsApi.md deleted file mode 100644 index 0f15dedd..00000000 --- a/auto-generated-sdk/docs/PaCalculationsApi.md +++ /dev/null @@ -1,645 +0,0 @@ - -# PaCalculationsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelCalculationById**](PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -[**getAllCalculations**](PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations -[**getCalculationParameters**](PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id -[**getCalculationStatusById**](PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id -[**getCalculationUnitResultById**](PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -[**postAndCalculate**](PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation -[**putAndCalculate**](PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. - - - -## cancelCalculationById - -> cancelCalculationById(id) - -Cancel PA calculation by id - -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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint - try { - apiInstance.cancelCalculationById(id); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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 PA 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - Integer pageNumber = 1; // Integer | - try { - CalculationsSummaryRoot result = apiInstance.getAllCalculations(pageNumber); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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**| | [optional] [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 - -> PACalculationParametersRoot getCalculationParameters(id) - -Get PA 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint - try { - PACalculationParametersRoot result = apiInstance.getCalculationParameters(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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 PA calculation endpoint | - -### Return type - -[**PACalculationParametersRoot**](PACalculationParametersRoot.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 PA 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 PA 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. -Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint - try { - CalculationStatusRoot result = apiInstance.getCalculationStatusById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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 PA 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, should contain X-FactSet-Api-PickUp-Progress header. | * 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 PA 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Get PA calculation status by id endpoint - String unitId = "unitId_example"; // String | from url, provided from the location header in the Get PA 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 PaCalculationsApi#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 PA calculation status by id endpoint | - **unitId** | **String**| from url, provided from the location header in the Get PA 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, paCalculationParametersRoot) - -Create and Run PA calculation - -This endpoint runs the PA calculation specified in the POST body parameters. -It can take one or more calculation units as input. - -Remarks: - -* Any settings in POST body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding - the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. - String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. - PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters - try { - Object result = apiInstance.postAndCalculate(xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] - **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] - -### Return type - -(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.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.
| -| **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.
| -| **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.
| -| **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, paCalculationParametersRoot) - -Create or Update PA calculation and run it. - -This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. -It can take one or more calculation units as input. - -Remarks: - -* Any settings in PUT body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding - the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint - Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation - String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. - PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters - try { - Object result = apiInstance.putAndCalculate(id, xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#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 PA calculation endpoint | - **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation | [optional] - **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] - **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.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/PaDoc.md b/auto-generated-sdk/docs/PaDoc.md deleted file mode 100644 index 3e85061b..00000000 --- a/auto-generated-sdk/docs/PaDoc.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# PaDoc - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | PA document path | - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PricingSourcesApi.md b/auto-generated-sdk/docs/PricingSourcesApi.md deleted file mode 100644 index 6ec18e36..00000000 --- a/auto-generated-sdk/docs/PricingSourcesApi.md +++ /dev/null @@ -1,97 +0,0 @@ - -# PricingSourcesApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getPAPricingSources**](PricingSourcesApi.md#getPAPricingSources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources - - - -## getPAPricingSources - -> PAPricingSourceRoot getPAPricingSources(name, category, directory) - -Get PA pricing sources - -This endpoint lists all the PA pricing sources that can be applied to a PA 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.PricingSourcesApi; - -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"); - - PricingSourcesApi apiInstance = new PricingSourcesApi(defaultClient); - String name = ""; // String | PA pricing sources name - String category = ""; // String | PA pricing sources category - String directory = ""; // String | The directory to get the PA pricing sources in - try { - PAPricingSourceRoot result = apiInstance.getPAPricingSources(name, category, directory); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PricingSourcesApi#getPAPricingSources"); - 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 -------------- | ------------- | ------------- | ------------- - **name** | **String**| PA pricing sources name | [optional] [default to ] - **category** | **String**| PA pricing sources category | [optional] [default to ] - **directory** | **String**| The directory to get the PA pricing sources in | [optional] [default to ] - -### Return type - -[**PAPricingSourceRoot**](PAPricingSourceRoot.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 PA pricing sources | * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. | * 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** | Pricing sources 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/PubCalculationsApi.md b/auto-generated-sdk/docs/PubCalculationsApi.md index 42019817..6ad0c8d7 100644 --- a/auto-generated-sdk/docs/PubCalculationsApi.md +++ b/auto-generated-sdk/docs/PubCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: text/plain, application/json, text/json +- **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | @@ -412,16 +412,16 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json, application/x-protobuf, application/pdf +- **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | Expected response once calculation is completed, returns result 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.
| +| **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.
| | **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.
| @@ -489,7 +489,7 @@ Name | Type | Description | Notes ### Return type -(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) +(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -498,18 +498,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation +- **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### 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.
| +| **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.
| | **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.
| +| **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.
| | **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.
| @@ -585,7 +585,7 @@ Name | Type | Description | Notes ### Return type -(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) +(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -594,19 +594,19 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/pdf +- **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| | **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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index ce27da35..642fda84 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -82,7 +82,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: text/plain, application/json, text/json +- **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/QuantDateListObsolete.md b/auto-generated-sdk/docs/QuantDateListObsolete.md deleted file mode 100644 index 9f60b98f..00000000 --- a/auto-generated-sdk/docs/QuantDateListObsolete.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# QuantDateListObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dates** | **java.util.List<String>** | | [optional] -**frequency** | **String** | | -**calendar** | **String** | | -**overrideUniversalScreenCalendar** | **Boolean** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantFdsDateObsolete.md b/auto-generated-sdk/docs/QuantFdsDateObsolete.md deleted file mode 100644 index 778d65d8..00000000 --- a/auto-generated-sdk/docs/QuantFdsDateObsolete.md +++ /dev/null @@ -1,21 +0,0 @@ - - -# QuantFdsDateObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**startDate** | **String** | | -**endDate** | **String** | | -**frequency** | **String** | | -**calendar** | **String** | | -**overrideUniversalScreenCalendar** | **Boolean** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md deleted file mode 100644 index cde3a56e..00000000 --- a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# QuantFqlExpressionObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expr** | **String** | | -**name** | **String** | | -**dateOffset** | **String** | | [optional] -**isArrayReturnType** | **Boolean** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md deleted file mode 100644 index 383c9dd1..00000000 --- a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md +++ /dev/null @@ -1,38 +0,0 @@ - - -# QuantIdentifierUniverseObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | -**identifiers** | **java.util.List<String>** | | -**source** | [**SourceEnum**](#SourceEnum) | | [optional] - - - -## Enum: UniverseTypeEnum - -Name | Value ----- | ----- -EQUITY | "Equity" -DEBT | "Debt" - - - -## Enum: SourceEnum - -Name | Value ----- | ----- -SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" -UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" -IDENTIFIERUNIVERSE | "IdentifierUniverse" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md deleted file mode 100644 index 11b77d7f..00000000 --- a/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# QuantScreeningExpressionObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expr** | **String** | | -**name** | **String** | | -**dateOffset** | **String** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md deleted file mode 100644 index d63e2df6..00000000 --- a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md +++ /dev/null @@ -1,39 +0,0 @@ - - -# QuantScreeningExpressionUniverseObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**universeExpr** | **String** | | -**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | -**securityExpr** | **String** | | [optional] -**source** | [**SourceEnum**](#SourceEnum) | | [optional] - - - -## Enum: UniverseTypeEnum - -Name | Value ----- | ----- -EQUITY | "Equity" -DEBT | "Debt" - - - -## Enum: SourceEnum - -Name | Value ----- | ----- -SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" -UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" -IDENTIFIERUNIVERSE | "IdentifierUniverse" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md deleted file mode 100644 index 8a817724..00000000 --- a/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# QuantUniversalScreenParameterObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**referenceName** | **String** | | -**name** | **String** | | - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md deleted file mode 100644 index 0b9214c3..00000000 --- a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# QuantUniversalScreenUniverseObsolete - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**screen** | **String** | | -**source** | [**SourceEnum**](#SourceEnum) | | [optional] - - - -## Enum: SourceEnum - -Name | Value ----- | ----- -SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" -UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" -IDENTIFIERUNIVERSE | "IdentifierUniverse" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md index 83983c13..2560d28e 100644 --- a/auto-generated-sdk/docs/SPARDateParameters.md +++ b/auto-generated-sdk/docs/SPARDateParameters.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **startdate** | **String** | Calculation's start date. | **enddate** | **String** | Calculation's end date. | **frequency** | **String** | Calculation's frequency. | +**useeachportfolioinception** | **Boolean** | Use Each Portfolio Inception | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/SparCalculationsApi.md b/auto-generated-sdk/docs/SparCalculationsApi.md index d5bca889..b529dd54 100644 --- a/auto-generated-sdk/docs/SparCalculationsApi.md +++ b/auto-generated-sdk/docs/SparCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: text/plain, application/json, text/json +- **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/StrategyDocumentsApi.md b/auto-generated-sdk/docs/StrategyDocumentsApi.md index 69f8a046..8ee4ae18 100644 --- a/auto-generated-sdk/docs/StrategyDocumentsApi.md +++ b/auto-generated-sdk/docs/StrategyDocumentsApi.md @@ -8,7 +8,6 @@ Method | HTTP request | Description [**getAxiomaEquityStrategyDocuments**](StrategyDocumentsApi.md#getAxiomaEquityStrategyDocuments) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory [**getAxiomaFIStrategyDocuments**](StrategyDocumentsApi.md#getAxiomaFIStrategyDocuments) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory [**getBarraStrategyDocuments**](StrategyDocumentsApi.md#getBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory -[**getFPOStrategyDocuments**](StrategyDocumentsApi.md#getFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory [**getNorthfieldStrategyDocuments**](StrategyDocumentsApi.md#getNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory @@ -262,89 +261,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.
| -## getFPOStrategyDocuments - -> DocumentDirectoriesRoot getFPOStrategyDocuments(path) - -Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory - -This endpoint looks up all FactSet Portfolio Optimizer strategy 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.StrategyDocumentsApi; - -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"); - - StrategyDocumentsApi apiInstance = new StrategyDocumentsApi(defaultClient); - String path = "Client:"; // String | The directory to get the strategy documents and sub-directories in - try { - DocumentDirectoriesRoot result = apiInstance.getFPOStrategyDocuments(path); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling StrategyDocumentsApi#getFPOStrategyDocuments"); - 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 strategy documents and sub-directories in | - -### 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 FactSet Portfolio Optimizer strategy 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.
| - - ## getNorthfieldStrategyDocuments > DocumentDirectoriesRoot getNorthfieldStrategyDocuments(path) diff --git a/auto-generated-sdk/docs/TemplateContentTypes.md b/auto-generated-sdk/docs/TemplateContentTypes.md deleted file mode 100644 index bd7fffe3..00000000 --- a/auto-generated-sdk/docs/TemplateContentTypes.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# TemplateContentTypes - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mandatory** | **java.util.List<String>** | Template mandatory fields | [optional] -**optional** | **java.util.List<String>** | Template optional fields | [optional] -**locked** | **java.util.List<String>** | Template locked fields | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponent.md b/auto-generated-sdk/docs/TemplatedPAComponent.md deleted file mode 100644 index 9807c2d7..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# TemplatedPAComponent - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | [optional] -**directory** | **String** | | [optional] -**snapshot** | **Boolean** | | [optional] -**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] -**description** | **String** | | [optional] -**name** | **String** | | [optional] -**parentTemplateId** | **String** | | [optional] -**type** | **String** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md deleted file mode 100644 index d8ee233a..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# TemplatedPAComponentParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **String** | Directory to create templated components | -**parentTemplateId** | **String** | Parent template id | -**description** | **String** | Component description. | [optional] -**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md deleted file mode 100644 index 3962efcc..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# TemplatedPAComponentParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md deleted file mode 100644 index b7b275c4..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md +++ /dev/null @@ -1,21 +0,0 @@ - - -# TemplatedPAComponentPostSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | [optional] -**description** | **String** | | [optional] -**name** | **String** | | [optional] -**parentTemplateId** | **String** | | [optional] -**type** | **String** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md deleted file mode 100644 index 26470db3..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# TemplatedPAComponentPostSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md deleted file mode 100644 index 5c49c451..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# TemplatedPAComponentRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md deleted file mode 100644 index ca4d272c..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# TemplatedPAComponentSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **String** | | [optional] -**name** | **String** | | [optional] -**parentTemplateId** | **String** | | [optional] -**type** | **String** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md deleted file mode 100644 index 2c872ec6..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# TemplatedPAComponentSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, TemplatedPAComponentSummary>**](TemplatedPAComponentSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md deleted file mode 100644 index 5aa26595..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# TemplatedPAComponentUpdateParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parentTemplateId** | **String** | Parent template id | [optional] -**description** | **String** | Component description. | [optional] -**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md deleted file mode 100644 index 120428e3..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# TemplatedPAComponentUpdateParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md deleted file mode 100644 index 9a45734e..00000000 --- a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md +++ /dev/null @@ -1,467 +0,0 @@ - -# TemplatedPaComponentsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createTemplatedPAComponents**](TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component -[**deleteTemplatedPAComponents**](TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component -[**getTemplatedPAComponentById**](TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id -[**getTemplatedPAComponentsInPath**](TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path -[**updateTemplatedPAComponents**](TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component - - - -## createTemplatedPAComponents - -> TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(templatedPAComponentParametersRoot) - -Create templated PA component - -This endpoint creates new component based off of linked PA template or unlinked PA template. - -Remarks: - -* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* Multi-horizon frequencies are not supported through this endpoint. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding - the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### 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.TemplatedPaComponentsApi; - -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"); - - TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); - TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = new TemplatedPAComponentParametersRoot(); // TemplatedPAComponentParametersRoot | Request Parameters - try { - TemplatedPAComponentPostSummaryRoot result = apiInstance.createTemplatedPAComponents(templatedPAComponentParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TemplatedPaComponentsApi#createTemplatedPAComponents"); - 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 -------------- | ------------- | ------------- | ------------- - **templatedPAComponentParametersRoot** | [**TemplatedPAComponentParametersRoot**](TemplatedPAComponentParametersRoot.md)| Request Parameters | - -### Return type - -[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: text/plain, application/json, text/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **201** | Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. | * 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.
| -| **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.
| -| **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.
| - - -## deleteTemplatedPAComponents - -> deleteTemplatedPAComponents(id) - -Delete templated PA component - -This endpoint deletes an existing templated PA component - -### 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.TemplatedPaComponentsApi; - -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"); - - TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component - try { - apiInstance.deleteTemplatedPAComponents(id); - } catch (ApiException e) { - System.err.println("Exception when calling TemplatedPaComponentsApi#deleteTemplatedPAComponents"); - 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**| Unique identifier for a templated PA component | - -### 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, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. | * 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** | Component 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.
| - - -## getTemplatedPAComponentById - -> TemplatedPAComponentRoot getTemplatedPAComponentById(id) - -Get templated PA component by id - -This endpoint fetches the templated PA component settings. - -### 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.TemplatedPaComponentsApi; - -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"); - - TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component - try { - TemplatedPAComponentRoot result = apiInstance.getTemplatedPAComponentById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentById"); - 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**| Unique identifier for a templated PA component | - -### Return type - -[**TemplatedPAComponentRoot**](TemplatedPAComponentRoot.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, templated PA component details. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Templated PA component 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.
| - - -## getTemplatedPAComponentsInPath - -> TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(directory) - -Get templated PA components in path - -This endpoint returns the list of templated PA components in path. - -### 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.TemplatedPaComponentsApi; - -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"); - - TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); - String directory = "Personal:TemplatedPAComponents/"; // String | Get templated PA components in path - try { - TemplatedPAComponentSummaryRoot result = apiInstance.getTemplatedPAComponentsInPath(directory); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentsInPath"); - 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 -------------- | ------------- | ------------- | ------------- - **directory** | **String**| Get templated PA components in path | - -### Return type - -[**TemplatedPAComponentSummaryRoot**](TemplatedPAComponentSummaryRoot.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 templated PA 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 data provided. Please check the request parameters before attempting again. | * 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.
| - - -## updateTemplatedPAComponents - -> TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(id, templatedPAComponentUpdateParametersRoot) - -Update templated PA component - -This endpoint allows the user to change the request body from an existing templated PA component. - -Remarks: - -* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* Multi-horizon frequencies are not supported through this endpoint. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding - the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### 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.TemplatedPaComponentsApi; - -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"); - - TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); - 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); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TemplatedPaComponentsApi#updateTemplatedPAComponents"); - 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**| Unique identifier for a templated PA component | - **templatedPAComponentUpdateParametersRoot** | [**TemplatedPAComponentUpdateParametersRoot**](TemplatedPAComponentUpdateParametersRoot.md)| Request Parameters | - -### Return type - -[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.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, updated 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 data provided. Please check the request parameters before attempting again. | * 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** | Component or 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.
| - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md deleted file mode 100644 index 6373dde5..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplate.md +++ /dev/null @@ -1,32 +0,0 @@ - - -# UnlinkedPATemplate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Template id. | [optional] -**directory** | **String** | Template directory. | [optional] -**templateTypeId** | **String** | Template type id | [optional] -**snapshot** | **Boolean** | snapshot. | [optional] -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] -**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**category** | **String** | Unlinked template category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md deleted file mode 100644 index 57284683..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateCategoryAndType - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** | **String** | Unlinked template category | [optional] -**name** | **String** | Unlinked template type | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md deleted file mode 100644 index 74d9792b..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# UnlinkedPATemplateCategoryAndTypeDetails - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Type Id | [optional] -**columns** | [**java.util.List<UnlinkedPATemplateColumnDetails>**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] -**groups** | [**java.util.List<UnlinkedPATemplateGroupDetails>**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] -**snapshot** | **Boolean** | Snapshot | [optional] -**category** | **String** | Unlinked template category | [optional] -**name** | **String** | Unlinked template type | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md deleted file mode 100644 index a402f96d..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateCategoryAndTypeDetailsRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md deleted file mode 100644 index 577c8681..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateCategoryAndTypeRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, UnlinkedPATemplateCategoryAndType>**](UnlinkedPATemplateCategoryAndType.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md deleted file mode 100644 index 6c4cc890..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# UnlinkedPATemplateColumnDetails - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Unlinked template column name | [optional] -**id** | **String** | FactSet-defined or User-defined Column identifier. | [optional] -**statistics** | **java.util.List<String>** | Column Statistic identifier | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md deleted file mode 100644 index 34bbd3c0..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# UnlinkedPATemplateGroupDetails - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Unlinked template group name | [optional] -**id** | **String** | FactSet-defined or User-defined Group identifier. | [optional] -**frequency** | **String** | Grouping frequency | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md deleted file mode 100644 index 6565a410..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# UnlinkedPATemplateParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **String** | The directory to create an unlinked PA template | -**templateTypeId** | **String** | Template type id | -**description** | **String** | Template description | [optional] -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] -**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md deleted file mode 100644 index 7f89e17d..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md deleted file mode 100644 index 4ba7f514..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# UnlinkedPATemplatePostSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Template id. | [optional] -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**category** | **String** | Unlinked template category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md deleted file mode 100644 index 6f488e6e..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplatePostSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md deleted file mode 100644 index 2821b693..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md deleted file mode 100644 index 879862c1..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# UnlinkedPATemplateSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **String** | Template description. | [optional] -**name** | **String** | Template name. | [optional] -**category** | **String** | Unlinked template category | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md deleted file mode 100644 index 79061ec3..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, UnlinkedPATemplateSummary>**](UnlinkedPATemplateSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md deleted file mode 100644 index f4cd57b9..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# UnlinkedPATemplateUpdateParameters - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **String** | Template description | [optional] -**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] -**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md deleted file mode 100644 index 61284b1f..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# UnlinkedPATemplateUpdateParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md deleted file mode 100644 index 7bb95b81..00000000 --- a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md +++ /dev/null @@ -1,648 +0,0 @@ - -# UnlinkedPaTemplatesApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template -[**deleteUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template -[**getDefaultUnlinkedPATemplateTypes**](UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. -[**getDetailsType**](UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. -[**getUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates -[**getUnlinkedPATemplatesById**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id -[**updateUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#updateUnlinkedPATemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template - - - -## createUnlinkedPATemplates - -> UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(unlinkedPATemplateParametersRoot) - -Create unlinked PA template - -This endpoint creates a template which is not linked to any specific PA3 tile. - -Remarks: - -* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. - If no mandatory fields are passed, then we can use the template as a component and skip the component creation. - -* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". - -* We cannot override the Locked fields when creating the Component. - -* Mandatory and locked strings are mutually exclusive. - -* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* Multi-horizon frequencies are not supported through this endpoint. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also - overriding the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = new UnlinkedPATemplateParametersRoot(); // UnlinkedPATemplateParametersRoot | Request Parameters - try { - UnlinkedPATemplatePostSummaryRoot result = apiInstance.createUnlinkedPATemplates(unlinkedPATemplateParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#createUnlinkedPATemplates"); - 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 -------------- | ------------- | ------------- | ------------- - **unlinkedPATemplateParametersRoot** | [**UnlinkedPATemplateParametersRoot**](UnlinkedPATemplateParametersRoot.md)| Request Parameters | - -### Return type - -[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.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 | -|-------------|-------------|------------------| -| **201** | Expected response, created a unlinked PA 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.
| -| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| - - -## deleteUnlinkedPATemplates - -> deleteUnlinkedPATemplates(id) - -Delete unlinked PA template - -This endpoint deletes an existing unliked PA 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template - try { - apiInstance.deleteUnlinkedPATemplates(id); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#deleteUnlinkedPATemplates"); - 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**| Unique identifier for an unlinked PA template | - -### Return type - -null (empty response body) - -### 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 | -|-------------|-------------|------------------| -| **204** | Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. | * 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.
| - - -## getDefaultUnlinkedPATemplateTypes - -> UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() - -Get default unlinked PA template types. - -This endpoint fetches default unlinked PA template types. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - try { - UnlinkedPATemplateCategoryAndTypeRoot result = apiInstance.getDefaultUnlinkedPATemplateTypes(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDefaultUnlinkedPATemplateTypes"); - 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 - -[**UnlinkedPATemplateCategoryAndTypeRoot**](UnlinkedPATemplateCategoryAndTypeRoot.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, default unlinked PA template types | * 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.
| - - -## getDetailsType - -> UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(id) - -Get unlinked PA template type details by id. - -This endpoint fetches the unlinked PA template type details. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - String id = "id_example"; // String | Unique identifier for an unlinked PA template type - try { - UnlinkedPATemplateCategoryAndTypeDetailsRoot result = apiInstance.getDetailsType(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDetailsType"); - 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**| Unique identifier for an unlinked PA template type | - -### Return type - -[**UnlinkedPATemplateCategoryAndTypeDetailsRoot**](UnlinkedPATemplateCategoryAndTypeDetailsRoot.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, details of the unlinked PA template type | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Unlinked PA template type 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.
| - - -## getUnlinkedPATemplates - -> UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(directory, category) - -Get unlinked PA templates - -This endpoint returns the list of unlinked PA templates. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - 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); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplates"); - 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 -------------- | ------------- | ------------- | ------------- - **directory** | **String**| Get unlinked PA templates in path. | [optional] - **category** | **String**| Get unlinked PA templates by category. | [optional] - -### Return type - -[**UnlinkedPATemplateSummaryRoot**](UnlinkedPATemplateSummaryRoot.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 unlinked PA templates. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| - - -## getUnlinkedPATemplatesById - -> UnlinkedPATemplateRoot getUnlinkedPATemplatesById(id) - -Get unlinked PA template details by id - -This endpoint fetches the template settings. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template - try { - UnlinkedPATemplateRoot result = apiInstance.getUnlinkedPATemplatesById(id); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplatesById"); - 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**| Unique identifier for an unlinked PA template | - -### Return type - -[**UnlinkedPATemplateRoot**](UnlinkedPATemplateRoot.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, get details of the unlinked PA 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.
| -| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| - - -## updateUnlinkedPATemplates - -> UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(id, unlinkedPATemplateUpdateParametersRoot) - -Update unlinked PA template - -This endpoint updates an existing unlinked PA template. - -Remarks: - -* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. - If no mandatory fields are passed, then we can use the template as a component and skip the component creation. - -* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". - -* We cannot override the Locked fields when creating the Component. - -* Mandatory and locked strings are mutually exclusive. - -* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. - -* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. - Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), - VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. - -* Multi-horizon frequencies are not supported through this endpoint. - -* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. - Additionally, while 'groupsall' returns all the group levels in the PA component, - setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding - the default frequency of the Beginning of Period to whatever we pass in the request body. - -* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### 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.UnlinkedPaTemplatesApi; - -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"); - - UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); - 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); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling UnlinkedPaTemplatesApi#updateUnlinkedPATemplates"); - 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**| Unique identifier for an unlinked PA template | - **unlinkedPATemplateUpdateParametersRoot** | [**UnlinkedPATemplateUpdateParametersRoot**](UnlinkedPATemplateUpdateParametersRoot.md)| Request Parameters | - -### Return type - -[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.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, updated the unlinked PA 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.
| -| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| - diff --git a/auto-generated-sdk/docs/ColumnStatisticsApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md similarity index 60% rename from auto-generated-sdk/docs/ColumnStatisticsApi.md rename to auto-generated-sdk/docs/VaultAttributionLoaderApi.md index e9e4c14a..9d588e13 100644 --- a/auto-generated-sdk/docs/ColumnStatisticsApi.md +++ b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md @@ -1,32 +1,33 @@ -# ColumnStatisticsApi +# VaultAttributionLoaderApi All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**getPAColumnStatistics**](ColumnStatisticsApi.md#getPAColumnStatistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics +[**vaultAttributionLoader**](VaultAttributionLoaderApi.md#vaultAttributionLoader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader -## getPAColumnStatistics +## vaultAttributionLoader -> ColumnStatisticRoot getPAColumnStatistics() +> VaultAttributionLoaderResponseRoot vaultAttributionLoader(batchId, file) -Get PA column statistics +Vault - External Attribution Loader -This endpoint lists all the column statistics that can be applied to a PA column. +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.ColumnStatisticsApi; +import factset.analyticsapi.engines.api.VaultAttributionLoaderApi; public class Example { public static void main(String[] args) { @@ -42,12 +43,14 @@ public class Example { HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); Bearer.setBearerToken("BEARER TOKEN"); - ColumnStatisticsApi apiInstance = new ColumnStatisticsApi(defaultClient); + VaultAttributionLoaderApi apiInstance = new VaultAttributionLoaderApi(defaultClient); + String batchId = "batchId_example"; // String | + File file = new File("/path/to/file"); // File | try { - ColumnStatisticRoot result = apiInstance.getPAColumnStatistics(); + VaultAttributionLoaderResponseRoot result = apiInstance.vaultAttributionLoader(batchId, file); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling ColumnStatisticsApi#getPAColumnStatistics"); + 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()); @@ -59,11 +62,15 @@ public class Example { ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **batchId** | **String**| | + **file** | **File**| | [optional] ### Return type -[**ColumnStatisticRoot**](ColumnStatisticRoot.md) +[**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md) ### Authorization @@ -71,17 +78,18 @@ This endpoint does not need any parameter. ### 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 a list of PA column statistics | * 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.
| | **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.
| +| **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/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/ColumnSummaryRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md similarity index 61% rename from auto-generated-sdk/docs/ColumnSummaryRoot.md rename to auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md index b038c090..5cc5749f 100644 --- a/auto-generated-sdk/docs/ColumnSummaryRoot.md +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md @@ -1,13 +1,13 @@ -# ColumnSummaryRoot +# VaultAttributionLoaderResponseRoot ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Map<String, ColumnSummary>**](ColumnSummary.md) | | +**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | **meta** | **Object** | | [optional] diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md index e6239922..3a7b8620 100644 --- a/auto-generated-sdk/docs/VaultCalculationsApi.md +++ b/auto-generated-sdk/docs/VaultCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: text/plain, application/json, text/json +- **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index 5382cb54..a4f9ba4d 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -5,9 +5,9 @@ engines-sdk jar engines-sdk - 6.2.0 + 6.3.0-rc.1 https://github.com/factset/analyticsapi-engines-java-sdk - SDK for FactSet Analytics Engines API + DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. ossrh diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java index 66b9f822..06b44189 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java @@ -118,7 +118,7 @@ public ApiClient(Map authMap) { httpClient = buildHttpClient(); this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("engines-api/6.2.0/java"); + setUserAgent("engines-api/6.3.0-rc.1/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap(); Authentication auth = null; diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java deleted file mode 100644 index 6889b457..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ /dev/null @@ -1,223 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.ColumnRoot; -import factset.analyticsapi.engines.models.ColumnSummaryRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnsApi { - private ApiClient apiClient; - public ColumnsApi() { - this(Configuration.getDefaultApiClient()); - } - - public ColumnsApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get PA column settings - * This endpoint returns the default settings of a PA column. - * @param id Unique identifier for a column (required) - @return ColumnRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns settings of a PA column. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. * 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 Column 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 ColumnRoot getPAColumnById(String id) throws ApiException { - return getPAColumnByIdWithHttpInfo(id).getData(); - } - - /** - * Get PA column settings - * This endpoint returns the default settings of a PA column. - * @param id Unique identifier for a column (required) - * @return ApiResponse<ColumnRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns settings of a PA column. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. * 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 Column 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 getPAColumnByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getPAColumnById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/columns/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("ColumnsApi.getPAColumnById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA columns - * This endpoint lists all the PA columns that can be applied to a calculation. - * @param name Column name (optional, default to ) - * @param category Column category (optional, default to ) - * @param directory The directory to get the columns in (optional, default to ) - @return ColumnSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA columns * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 ColumnSummaryRoot getPAColumns(String name, String category, String directory) throws ApiException { - return getPAColumnsWithHttpInfo(name, category, directory).getData(); - } - - /** - * Get PA columns - * This endpoint lists all the PA columns that can be applied to a calculation. - * @param name Column name (optional, default to ) - * @param category Column category (optional, default to ) - * @param directory The directory to get the columns in (optional, default to ) - * @return ApiResponse<ColumnSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA columns * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 getPAColumnsWithHttpInfo(String name, String category, String directory) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/columns"; - - // 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("", "name", name)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); - - - - - 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("ColumnsApi.getPAColumns", 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 f7f22832..47e75669 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 @@ -16,7 +16,6 @@ import factset.analyticsapi.engines.models.ClientErrorResponse; import factset.analyticsapi.engines.models.ComponentSummaryRoot; -import factset.analyticsapi.engines.models.PAComponentRoot; import factset.analyticsapi.engines.models.SPARComponentRoot; import factset.analyticsapi.engines.models.VaultComponentRoot; @@ -49,184 +48,6 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } - /** - * Get PA component by id - * This endpoint returns the default settings of a PA component. - * @param id Unique identifier for a PA component (required) - @return PAComponentRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the default settings of a PA component. * 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 PA component id. * 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 Component 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 PAComponentRoot getPAComponentById(String id) throws ApiException { - return getPAComponentByIdWithHttpInfo(id).getData(); - } - - /** - * Get PA component by id - * This endpoint returns the default settings of a PA component. - * @param id Unique identifier for a PA component (required) - * @return ApiResponse<PAComponentRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the default settings of a PA component. * 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 PA component id. * 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 Component 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 getPAComponentByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getPAComponentById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/components/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("ComponentsApi.getPAComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA components - * This endpoint returns the list of PA components in a given PA 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 PA 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 PA 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 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 getPAComponents(String document) throws ApiException { - return getPAComponentsWithHttpInfo(document).getData(); - } - - /** - * Get PA components - * This endpoint returns the list of PA components in a given PA 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 PA 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 PA 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 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 getPAComponentsWithHttpInfo(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 getPAComponents"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/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.getPAComponents", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Get SPAR component by id * This endpoint returns the default settings of a SPAR 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 f6f84ce0..b372c303 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 @@ -46,114 +46,6 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } - /** - * Convert PA dates to absolute format - * 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 ( Account Name ending with .ACCT or .ACTM ) (required) - * @param startdate Start Date (optional) - @return DateParametersSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the converted dates in yyyymmdd format. * 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 is 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 Document or 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 DateParametersSummaryRoot convertPADatesToAbsoluteFormat(String enddate, String componentid, String account, String startdate) throws ApiException { - return convertPADatesToAbsoluteFormatWithHttpInfo(enddate, componentid, account, startdate).getData(); - } - - /** - * Convert PA dates to absolute format - * 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 ( Account Name ending with .ACCT or .ACTM ) (required) - * @param startdate Start Date (optional) - * @return ApiResponse<DateParametersSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the converted dates in yyyymmdd format. * 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 is 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 Document or 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 convertPADatesToAbsoluteFormatWithHttpInfo(String enddate, String componentid, String account, String startdate) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'enddate' is set - if (enddate == null) { - throw new ApiException(400, "Missing the required parameter 'enddate' when calling convertPADatesToAbsoluteFormat"); - } - - // verify the required parameter 'componentid' is set - if (componentid == null) { - throw new ApiException(400, "Missing the required parameter 'componentid' when calling convertPADatesToAbsoluteFormat"); - } - - // verify the required parameter 'account' is set - if (account == null) { - throw new ApiException(400, "Missing the required parameter 'account' when calling convertPADatesToAbsoluteFormat"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/dates"; - - // 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("", "startdate", startdate)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "enddate", enddate)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "componentid", componentid)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "account", account)); - - - - - 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("DatesApi.convertPADatesToAbsoluteFormat", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Convert Vault dates to absolute format * 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. 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..6ec32ac2 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 @@ -46,95 +46,6 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } - /** - * Get PA3 documents and sub-directories in a directory - * This endpoint looks up all PA3 documents and sub-directories in a given directory. - * @param path The directory to get the documents and sub-directories 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 PA3 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 getPA3Documents(String path) throws ApiException { - return getPA3DocumentsWithHttpInfo(path).getData(); - } - - /** - * Get PA3 documents and sub-directories in a directory - * This endpoint looks up all PA3 documents and sub-directories in a given directory. - * @param path The directory to get the documents and sub-directories 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 PA3 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 getPA3DocumentsWithHttpInfo(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 getPA3Documents"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/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.getPA3Documents", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Gets Publisher documents and sub-directories in a directory * This endpoint looks up all Publisher documents and sub-directories in a given directory. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 6a3564fe..bea71fc9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -110,7 +110,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java deleted file mode 100644 index 5c48f02c..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ /dev/null @@ -1,592 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.CalculationInfoRoot; -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.FPOOptimizationParametersRoot; -import factset.analyticsapi.engines.models.ObjectRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FpoOptimizerApi { - private ApiClient apiClient; - public FpoOptimizerApi() { - this(Configuration.getDefaultApiClient()); - } - - public FpoOptimizerApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Cancel FPO optimization by id - * This is the endpoint to cancel a previously submitted optimization. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, optimization 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 optimization 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.
- */ - public void cancelOptimizationById(String id) throws ApiException { - cancelOptimizationByIdWithHttpInfo(id); - } - - /** - * Cancel FPO optimization by id - * This is the endpoint to cancel a previously submitted optimization. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @return ApiResponse<Void> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, optimization 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 optimization 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.
- */ - public ApiResponse cancelOptimizationByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling cancelOptimizationById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "text/plain", "application/json", "text/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.cancelOptimizationById", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get FPO optimization parameters by id - * This is the endpoint that returns the optimization parameters passed for an optimization. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - @return FPOOptimizationParametersRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the FPO optimization 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 Optimization 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.
- */ - public FPOOptimizationParametersRoot getOptimizationParameters(String id) throws ApiException { - return getOptimizationParametersWithHttpInfo(id).getData(); - } - - /** - * Get FPO optimization parameters by id - * This is the endpoint that returns the optimization parameters passed for an optimization. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @return ApiResponse<FPOOptimizationParametersRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the FPO optimization 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 Optimization 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.
- */ - public ApiResponse getOptimizationParametersWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationParameters"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("FpoOptimizerApi.getOptimizationParameters", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get FPO optimization result by id - * This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. - * @param id from url, provided from the location header in the Get FPO optimization status by id endpoint (required) - * @param accept Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) - @return ObjectRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response once optimization is completed, returns JSON. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
- */ - public ObjectRoot getOptimizationResult(String id, String accept) throws ApiException { - return getOptimizationResultWithHttpInfo(id, accept).getData(); - } - - /** - * Get FPO optimization result by id - * This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. - * @param id from url, provided from the location header in the Get FPO optimization status by id endpoint (required) - * @param accept Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) - * @return ApiResponse<ObjectRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response once optimization is completed, returns JSON. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
- */ - public ApiResponse getOptimizationResultWithHttpInfo(String id, String accept) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationResult"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}/result" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); - - - if (accept != null) - localVarHeaderParams.put("Accept", apiClient.parameterToString(accept)); - - - - 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("FpoOptimizerApi.getOptimizationResult", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get FPO optimization status by id - * This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - @return (For 201 status - ObjectRoot)(For 202 status - null) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response once optimization is completed, returns 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.
202 Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
- */ - public Object getOptimizationStatusById(String id) throws ApiException { - return getOptimizationStatusByIdWithHttpInfo(id).getData(); - } - - /** - * Get FPO optimization status by id - * This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @return ApiResponse<Object>(For 201 status - ObjectRoot)(For 202 status - null) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response once optimization is completed, returns 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.
202 Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
- */ - public ApiResponse getOptimizationStatusByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationStatusById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}/status" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.getOptimizationStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Create and Run FPO optimization - * This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param fpOOptimizationParametersRoot Optimization Parameters (optional) - @return (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 optimization 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 optimization 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 optimization 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.
- */ - public Object postAndOptimize(Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { - return postAndOptimizeWithHttpInfo(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot).getData(); - } - - /** - * Create and Run FPO optimization - * This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param fpOOptimizationParametersRoot Optimization Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 optimization 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 optimization 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 optimization 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.
- */ - public ApiResponse postAndOptimizeWithHttpInfo(Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { - Object localVarPostBody = fpOOptimizationParametersRoot; - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations"; - - // 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(); - - - if (xFactSetApiLongRunningDeadline != null) - localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); -if (cacheControl != null) - localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); - - - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.postAndOptimize", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Create or Update FPO optimization and run it. - * 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. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param fpOOptimizationParametersRoot Optimization Parameters (optional) - @return (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 Optimization 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 optimization 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 optimization 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 optimization 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.
- */ - public Object putAndOptimize(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { - return putAndOptimizeWithHttpInfo(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot).getData(); - } - - /** - * Create or Update FPO optimization and run it. - * 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. - * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param fpOOptimizationParametersRoot Optimization Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 Optimization 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 optimization 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 optimization 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 optimization 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.
- */ - public ApiResponse putAndOptimizeWithHttpInfo(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { - Object localVarPostBody = fpOOptimizationParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling putAndOptimize"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); - - - if (xFactSetApiLongRunningDeadline != null) - localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); -if (cacheControl != null) - localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); - - - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - returnTypeMap.put(409, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.putAndOptimize", localVarPath, "PUT", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} 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..d78d37c4 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 @@ -45,81 +45,6 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } - /** - * Get PA frequencies - * This endpoint lists all the frequencies that can be applied to a PA 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 PA 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 getPAFrequencies() throws ApiException { - return getPAFrequenciesWithHttpInfo().getData(); - } - - /** - * Get PA frequencies - * This endpoint lists all the frequencies that can be applied to a PA 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 PA 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 getPAFrequenciesWithHttpInfo() throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/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.getPAFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody, - 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. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java deleted file mode 100644 index 6ac12439..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ /dev/null @@ -1,199 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.FrequencyRoot; -import factset.analyticsapi.engines.models.GroupRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class GroupsApi { - private ApiClient apiClient; - public GroupsApi() { - this(Configuration.getDefaultApiClient()); - } - - public GroupsApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get PA grouping frequencies - * This endpoint lists all the PA grouping frequencies that can be applied to a PA 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 PA grouping 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 getPAGroupingFrequencies() throws ApiException { - return getPAGroupingFrequenciesWithHttpInfo().getData(); - } - - /** - * Get PA grouping frequencies - * This endpoint lists all the PA grouping frequencies that can be applied to a PA 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 PA grouping 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 getPAGroupingFrequenciesWithHttpInfo() throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/grouping-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("GroupsApi.getPAGroupingFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA groups - * This endpoint lists all the PA groups that can be applied to a PA calculation. - @return GroupRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA groups * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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 GroupRoot getPAGroups() throws ApiException { - return getPAGroupsWithHttpInfo().getData(); - } - - /** - * Get PA groups - * This endpoint lists all the PA groups that can be applied to a PA calculation. - * @return ApiResponse<GroupRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA groups * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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 getPAGroupsWithHttpInfo() throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/groups"; - - // 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("GroupsApi.getPAGroups", 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/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java deleted file mode 100644 index a0b911c8..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ /dev/null @@ -1,500 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.LinkedPATemplateParametersRoot; -import factset.analyticsapi.engines.models.LinkedPATemplatePostSummaryRoot; -import factset.analyticsapi.engines.models.LinkedPATemplateRoot; -import factset.analyticsapi.engines.models.LinkedPATemplateSummaryRoot; -import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParametersRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPaTemplatesApi { - private ApiClient apiClient; - public LinkedPaTemplatesApi() { - this(Configuration.getDefaultApiClient()); - } - - public LinkedPaTemplatesApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a linked PA template - * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - * @param linkedPATemplateParametersRoot Request Parameters (required) - @return LinkedPATemplatePostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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.
404 Component 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.
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 LinkedPATemplatePostSummaryRoot createLinkedPATemplates(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { - return createLinkedPATemplatesWithHttpInfo(linkedPATemplateParametersRoot).getData(); - } - - /** - * Create a linked PA template - * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - * @param linkedPATemplateParametersRoot Request Parameters (required) - * @return ApiResponse<LinkedPATemplatePostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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.
404 Component 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.
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 createLinkedPATemplatesWithHttpInfo(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { - Object localVarPostBody = linkedPATemplateParametersRoot; - - // verify the required parameter 'linkedPATemplateParametersRoot' is set - if (linkedPATemplateParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'linkedPATemplateParametersRoot' when calling createLinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/linked-templates"; - - // 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 = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.createLinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Delete a linked PA template. - * This endpoint deletes an existing linked PA template. - * @param id Unique identifier for a linked PA template (required) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public void deleteLinkedPATemplates(String id) throws ApiException { - deleteLinkedPATemplatesWithHttpInfo(id); - } - - /** - * Delete a linked PA template. - * This endpoint deletes an existing linked PA template. - * @param id Unique identifier for a linked PA template (required) - * @return ApiResponse<Void> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public ApiResponse deleteLinkedPATemplatesWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling deleteLinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "text/plain", "application/json", "text/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.deleteLinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get linked PA templates - * This endpoint returns the list of linked PA templates in given path. - * @param directory Get linked PA templates in path. (optional) - * @param documentDirectory Get linked PA templates for documents in document path (optional) - * @param documentName Get linked PA templates for documents by document name (optional) - @return LinkedPATemplateSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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 LinkedPATemplateSummaryRoot getLinkedPATemplates(String directory, String documentDirectory, String documentName) throws ApiException { - return getLinkedPATemplatesWithHttpInfo(directory, documentDirectory, documentName).getData(); - } - - /** - * Get linked PA templates - * This endpoint returns the list of linked PA templates in given path. - * @param directory Get linked PA templates in path. (optional) - * @param documentDirectory Get linked PA templates for documents in document path (optional) - * @param documentName Get linked PA templates for documents by document name (optional) - * @return ApiResponse<LinkedPATemplateSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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 getLinkedPATemplatesWithHttpInfo(String directory, String documentDirectory, String documentName) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/linked-templates"; - - // 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("", "directory", directory)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentDirectory", documentDirectory)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentName", documentName)); - - - - - 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("LinkedPaTemplatesApi.getLinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get linked PA template by id - * This endpoint fetches the linked PA template settings. - * @param id Unique identifier for a linked PA template (required) - @return LinkedPATemplateRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public LinkedPATemplateRoot getLinkedPATemplatesById(String id) throws ApiException { - return getLinkedPATemplatesByIdWithHttpInfo(id).getData(); - } - - /** - * Get linked PA template by id - * This endpoint fetches the linked PA template settings. - * @param id Unique identifier for a linked PA template (required) - * @return ApiResponse<LinkedPATemplateRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public ApiResponse getLinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getLinkedPATemplatesById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("LinkedPaTemplatesApi.getLinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Update a linked PA template - * This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - * @param id Unique identifier for a linked PA template (required) - * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) - @return LinkedPATemplatePostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 or component 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 LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { - return updateLinkedPATemplatesWithHttpInfo(id, linkedPATemplateUpdateParametersRoot).getData(); - } - - /** - * Update a linked PA template - * This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - * @param id Unique identifier for a linked PA template (required) - * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) - * @return ApiResponse<LinkedPATemplatePostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 or component 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 updateLinkedPATemplatesWithHttpInfo(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { - Object localVarPostBody = linkedPATemplateUpdateParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling updateLinkedPATemplates"); - } - - // verify the required parameter 'linkedPATemplateUpdateParametersRoot' is set - if (linkedPATemplateUpdateParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'linkedPATemplateUpdateParametersRoot' when calling updateLinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "application/json" - }; - 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("LinkedPaTemplatesApi.updateLinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java deleted file mode 100644 index e8e507f4..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ /dev/null @@ -1,688 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.CalculationStatusRoot; -import factset.analyticsapi.engines.models.CalculationsSummaryRoot; -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.ObjectRoot; -import factset.analyticsapi.engines.models.PACalculationParametersRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PaCalculationsApi { - private ApiClient apiClient; - public PaCalculationsApi() { - this(Configuration.getDefaultApiClient()); - } - - public PaCalculationsApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Cancel PA calculation by id - * This is the endpoint to cancel a previously submitted calculation. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @throws ApiException if fails to make API call - * @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.
- */ - public void cancelCalculationById(String id) throws ApiException { - cancelCalculationByIdWithHttpInfo(id); - } - - /** - * Cancel PA calculation by id - * This is the endpoint to cancel a previously submitted calculation. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @return ApiResponse<Void> - * @throws ApiException if fails to make API call - * @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.
- */ - public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling cancelCalculationById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "text/plain", "application/json", "text/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.cancelCalculationById", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get all calculations - * This endpoints returns all calculation requests. - * @param pageNumber (optional, default to 1) - @return CalculationsSummaryRoot - * @throws ApiException if fails to make API call - * @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.
- */ - public CalculationsSummaryRoot getAllCalculations(Integer pageNumber) throws ApiException { - return getAllCalculationsWithHttpInfo(pageNumber).getData(); - } - - /** - * Get all calculations - * This endpoints returns all calculation requests. - * @param pageNumber (optional, default to 1) - * @return ApiResponse<CalculationsSummaryRoot> - * @throws ApiException if fails to make API call - * @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.
- */ - public ApiResponse getAllCalculationsWithHttpInfo(Integer pageNumber) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations"; - - // 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("", "pageNumber", pageNumber)); - - - - - 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("PaCalculationsApi.getAllCalculations", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA calculation parameters by id - * This is the endpoint that returns the calculation parameters passed for a calculation. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - @return PACalculationParametersRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the PA 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.
- */ - public PACalculationParametersRoot getCalculationParameters(String id) throws ApiException { - return getCalculationParametersWithHttpInfo(id).getData(); - } - - /** - * Get PA calculation parameters by id - * This is the endpoint that returns the calculation parameters passed for a calculation. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @return ApiResponse<PACalculationParametersRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns the PA 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.
- */ - public ApiResponse getCalculationParametersWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationParameters"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("PaCalculationsApi.getCalculationParameters", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA 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. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - @return CalculationStatusRoot - * @throws ApiException if fails to make API call - * @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, should contain X-FactSet-Api-PickUp-Progress header. * 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.
- */ - public CalculationStatusRoot getCalculationStatusById(String id) throws ApiException { - return getCalculationStatusByIdWithHttpInfo(id).getData(); - } - - /** - * Get PA 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. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @return ApiResponse<CalculationStatusRoot> - * @throws ApiException if fails to make API call - * @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, should contain X-FactSet-Api-PickUp-Progress header. * 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.
- */ - public ApiResponse getCalculationStatusByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationStatusById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/status" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(202, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getCalculationStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA 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. - * @param id from url, provided from the location header in the Get PA calculation status by id endpoint (required) - * @param unitId from url, provided from the location header in the Get PA calculation status by id endpoint (required) - @return ObjectRoot - * @throws ApiException if fails to make API call - * @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.
- */ - public ObjectRoot getCalculationUnitResultById(String id, String unitId) throws ApiException { - return getCalculationUnitResultByIdWithHttpInfo(id, unitId).getData(); - } - - /** - * Get PA 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. - * @param id from url, provided from the location header in the Get PA calculation status by id endpoint (required) - * @param unitId from url, provided from the location header in the Get PA calculation status by id endpoint (required) - * @return ApiResponse<ObjectRoot> - * @throws ApiException if fails to make API call - * @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.
- */ - public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, String unitId) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationUnitResultById"); - } - - // verify the required parameter 'unitId' is set - if (unitId == null) { - throw new ApiException(400, "Missing the required parameter 'unitId' when calling getCalculationUnitResultById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) - .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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", "application/x-protobuf" - }; - 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("PaCalculationsApi.getCalculationUnitResultById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Create and Run PA calculation - * This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param paCalculationParametersRoot Calculation Parameters (optional) - @return (For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) - * @throws ApiException if fails to make API call - * @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.
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.
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.
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.
- */ - public Object postAndCalculate(Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { - return postAndCalculateWithHttpInfo(xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot).getData(); - } - - /** - * Create and Run PA calculation - * This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param paCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) - * @throws ApiException if fails to make API call - * @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.
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.
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.
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.
- */ - public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { - Object localVarPostBody = paCalculationParametersRoot; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations"; - - // 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(); - - - if (xFactSetApiLongRunningDeadline != null) - localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); -if (cacheControl != null) - localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); - - - - final String[] localVarAccepts = { - "application/json", "application/x-protobuf" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(200, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.postAndCalculate", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Create or Update PA calculation and run it. - * This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param paCalculationParametersRoot Calculation Parameters (optional) - @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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.
- */ - public Object putAndCalculate(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { - return putAndCalculateWithHttpInfo(id, xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot).getData(); - } - - /** - * Create or Update PA calculation and run it. - * This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) - * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) - * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) - * @param paCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) - * @throws ApiException if fails to make API call - * @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.
- */ - public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { - Object localVarPostBody = paCalculationParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling putAndCalculate"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); - - - if (xFactSetApiLongRunningDeadline != null) - localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); -if (cacheControl != null) - localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); - - - - final String[] localVarAccepts = { - "application/json", "application/x-protobuf" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); - returnTypeMap.put(200, new GenericType(){}); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - returnTypeMap.put(409, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.putAndCalculate", localVarPath, "PUT", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java deleted file mode 100644 index f7a16890..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ /dev/null @@ -1,139 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.PAPricingSourceRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PricingSourcesApi { - private ApiClient apiClient; - public PricingSourcesApi() { - this(Configuration.getDefaultApiClient()); - } - - public PricingSourcesApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get PA pricing sources - * This endpoint lists all the PA pricing sources that can be applied to a PA calculation. - * @param name PA pricing sources name (optional, default to ) - * @param category PA pricing sources category (optional, default to ) - * @param directory The directory to get the PA pricing sources in (optional, default to ) - @return PAPricingSourceRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA pricing sources * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. * 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 Pricing sources 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 PAPricingSourceRoot getPAPricingSources(String name, String category, String directory) throws ApiException { - return getPAPricingSourcesWithHttpInfo(name, category, directory).getData(); - } - - /** - * Get PA pricing sources - * This endpoint lists all the PA pricing sources that can be applied to a PA calculation. - * @param name PA pricing sources name (optional, default to ) - * @param category PA pricing sources category (optional, default to ) - * @param directory The directory to get the PA pricing sources in (optional, default to ) - * @return ApiResponse<PAPricingSourceRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of PA pricing sources * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. * 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 Pricing sources 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 getPAPricingSourcesWithHttpInfo(String name, String category, String directory) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/pricing-sources"; - - // 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("", "name", name)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); - - - - - 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("PricingSourcesApi.getPAPricingSources", 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/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index 2c54e566..c5764174 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -399,9 +399,9 @@ public ApiResponse getCalculationStatusByIdWithHttpInfo(S Status Code Description Response Headers 200 Expected response once calculation is completed, returns result 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.
+ 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.
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.
@@ -422,9 +422,9 @@ public File getCalculationUnitResultById(String id, String unitId) throws ApiExc Status Code Description Response Headers 200 Expected response once calculation is completed, returns result 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.
+ 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.
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.
@@ -458,7 +458,7 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str final String[] localVarAccepts = { - "application/json", "application/x-protobuf", "application/pdf" + "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -486,18 +486,18 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + @return (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) * @throws ApiException if fails to make API call * @http.response.details - + - + @@ -514,18 +514,18 @@ public Object postAndCalculate(Integer xFactSetApiLongRunningDeadline, String ca * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + * @return ApiResponse<Object>(For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) * @throws ApiException if fails to make API call * @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.
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.
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.
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.
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.
- + - + @@ -553,7 +553,7 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR final String[] localVarAccepts = { - "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" + "application/json", "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -567,9 +567,9 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR GenericType localVarReturnType = new GenericType() {}; Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(200, new GenericType(){}); returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); @@ -584,19 +584,19 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + @return (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) * @throws ApiException if fails to make API call * @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.
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.
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.
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.
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.
- + - - + + @@ -614,19 +614,19 @@ public Object putAndCalculate(String id, Integer xFactSetApiLongRunningDeadline, * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + * @return ApiResponse<Object>(For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) * @throws ApiException if fails to make API call * @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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
- + - - + + @@ -660,7 +660,7 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactS final String[] localVarAccepts = { - "application/pdf" + "application/json", "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -674,9 +674,9 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactS GenericType localVarReturnType = new GenericType() {}; Map returnTypeMap = new HashMap(); - returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(200, new GenericType(){}); returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); returnTypeMap.put(409, new GenericType(){}); 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 d96e755c..c36170e6 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 @@ -112,7 +112,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index 2e2f006e..a4922c8b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index b31f7a3c..efe262ef 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -313,95 +313,6 @@ public ApiResponse getBarraStrategyDocumentsWithHttpInf localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } - /** - * Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory - * This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. - * @param path The directory to get the strategy documents and sub-directories in (required) - @return DocumentDirectoriesRoot - * @throws ApiException if fails to make API call - * @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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
- - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of FactSet Portfolio Optimizer strategy 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 getFPOStrategyDocuments(String path) throws ApiException { - return getFPOStrategyDocumentsWithHttpInfo(path).getData(); - } - - /** - * Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory - * This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. - * @param path The directory to get the strategy documents and sub-directories 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 FactSet Portfolio Optimizer strategy 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 getFPOStrategyDocumentsWithHttpInfo(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 getFPOStrategyDocuments"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/fpo/v3/strategies/{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("StrategyDocumentsApi.getFPOStrategyDocuments", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Get Northfield strategy documents and sub-directories in a directory * This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java deleted file mode 100644 index 280f95c9..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ /dev/null @@ -1,496 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.TemplatedPAComponentParametersRoot; -import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummaryRoot; -import factset.analyticsapi.engines.models.TemplatedPAComponentRoot; -import factset.analyticsapi.engines.models.TemplatedPAComponentSummaryRoot; -import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParametersRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPaComponentsApi { - private ApiClient apiClient; - public TemplatedPaComponentsApi() { - this(Configuration.getDefaultApiClient()); - } - - public TemplatedPaComponentsApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create templated PA component - * This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param templatedPAComponentParametersRoot Request Parameters (required) - @return TemplatedPAComponentPostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. * 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.
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.
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 TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { - return createTemplatedPAComponentsWithHttpInfo(templatedPAComponentParametersRoot).getData(); - } - - /** - * Create templated PA component - * This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param templatedPAComponentParametersRoot Request Parameters (required) - * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. * 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.
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.
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 createTemplatedPAComponentsWithHttpInfo(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { - Object localVarPostBody = templatedPAComponentParametersRoot; - - // verify the required parameter 'templatedPAComponentParametersRoot' is set - if (templatedPAComponentParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'templatedPAComponentParametersRoot' when calling createTemplatedPAComponents"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/templated-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(); - - - - - - final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.createTemplatedPAComponents", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Delete templated PA component - * This endpoint deletes an existing templated PA component - * @param id Unique identifier for a templated PA component (required) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. * 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 Component 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 void deleteTemplatedPAComponents(String id) throws ApiException { - deleteTemplatedPAComponentsWithHttpInfo(id); - } - - /** - * Delete templated PA component - * This endpoint deletes an existing templated PA component - * @param id Unique identifier for a templated PA component (required) - * @return ApiResponse<Void> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. * 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 Component 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 deleteTemplatedPAComponentsWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling deleteTemplatedPAComponents"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "text/plain", "application/json", "text/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.deleteTemplatedPAComponents", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get templated PA component by id - * This endpoint fetches the templated PA component settings. - * @param id Unique identifier for a templated PA component (required) - @return TemplatedPAComponentRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA component 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 TemplatedPAComponentRoot getTemplatedPAComponentById(String id) throws ApiException { - return getTemplatedPAComponentByIdWithHttpInfo(id).getData(); - } - - /** - * Get templated PA component by id - * This endpoint fetches the templated PA component settings. - * @param id Unique identifier for a templated PA component (required) - * @return ApiResponse<TemplatedPAComponentRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA component 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 getTemplatedPAComponentByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getTemplatedPAComponentById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("TemplatedPaComponentsApi.getTemplatedPAComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get templated PA components in path - * This endpoint returns the list of templated PA components in path. - * @param directory Get templated PA components in path (required) - @return TemplatedPAComponentSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list templated PA 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 data provided. Please check the request parameters before attempting again. * 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 TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(String directory) throws ApiException { - return getTemplatedPAComponentsInPathWithHttpInfo(directory).getData(); - } - - /** - * Get templated PA components in path - * This endpoint returns the list of templated PA components in path. - * @param directory Get templated PA components in path (required) - * @return ApiResponse<TemplatedPAComponentSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list templated PA 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 data provided. Please check the request parameters before attempting again. * 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 getTemplatedPAComponentsInPathWithHttpInfo(String directory) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'directory' is set - if (directory == null) { - throw new ApiException(400, "Missing the required parameter 'directory' when calling getTemplatedPAComponentsInPath"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/templated-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("", "directory", directory)); - - - - - 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(){}); - - return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.getTemplatedPAComponentsInPath", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Update templated PA component - * This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param id Unique identifier for a templated PA component (required) - * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) - @return TemplatedPAComponentPostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated 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 data provided. Please check the request parameters before attempting again. * 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 Component or 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.
- */ - public TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { - return updateTemplatedPAComponentsWithHttpInfo(id, templatedPAComponentUpdateParametersRoot).getData(); - } - - /** - * Update templated PA component - * This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param id Unique identifier for a templated PA component (required) - * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) - * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated 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 data provided. Please check the request parameters before attempting again. * 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 Component or 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.
- */ - public ApiResponse updateTemplatedPAComponentsWithHttpInfo(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { - Object localVarPostBody = templatedPAComponentUpdateParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling updateTemplatedPAComponents"); - } - - // verify the required parameter 'templatedPAComponentUpdateParametersRoot' is set - if (templatedPAComponentUpdateParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'templatedPAComponentUpdateParametersRoot' when calling updateTemplatedPAComponents"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "application/json" - }; - 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("TemplatedPaComponentsApi.updateTemplatedPAComponents", localVarPath, "PUT", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java deleted file mode 100644 index 7093fb25..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ /dev/null @@ -1,658 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetailsRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplateParametersRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummaryRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplateRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplateSummaryRoot; -import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParametersRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPaTemplatesApi { - private ApiClient apiClient; - public UnlinkedPaTemplatesApi() { - this(Configuration.getDefaultApiClient()); - } - - public UnlinkedPaTemplatesApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create unlinked PA template - * This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param unlinkedPATemplateParametersRoot Request Parameters (required) - @return UnlinkedPATemplatePostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, created a unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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 UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { - return createUnlinkedPATemplatesWithHttpInfo(unlinkedPATemplateParametersRoot).getData(); - } - - /** - * Create unlinked PA template - * This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param unlinkedPATemplateParametersRoot Request Parameters (required) - * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response, created a unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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 createUnlinkedPATemplatesWithHttpInfo(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { - Object localVarPostBody = unlinkedPATemplateParametersRoot; - - // verify the required parameter 'unlinkedPATemplateParametersRoot' is set - if (unlinkedPATemplateParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateParametersRoot' when calling createUnlinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; - - // 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 = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.createUnlinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Delete unlinked PA template - * This endpoint deletes an existing unliked PA template. - * @param id Unique identifier for an unlinked PA template (required) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public void deleteUnlinkedPATemplates(String id) throws ApiException { - deleteUnlinkedPATemplatesWithHttpInfo(id); - } - - /** - * Delete unlinked PA template - * This endpoint deletes an existing unliked PA template. - * @param id Unique identifier for an unlinked PA template (required) - * @return ApiResponse<Void> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
- */ - public ApiResponse deleteUnlinkedPATemplatesWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling deleteUnlinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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" }; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(400, new GenericType(){}); - returnTypeMap.put(404, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.deleteUnlinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get default unlinked PA template types. - * This endpoint fetches default unlinked PA template types. - @return UnlinkedPATemplateCategoryAndTypeRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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 UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() throws ApiException { - return getDefaultUnlinkedPATemplateTypesWithHttpInfo().getData(); - } - - /** - * Get default unlinked PA template types. - * This endpoint fetches default unlinked PA template types. - * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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 getDefaultUnlinkedPATemplateTypesWithHttpInfo() throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types"; - - // 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("UnlinkedPaTemplatesApi.getDefaultUnlinkedPATemplateTypes", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get unlinked PA template type details by id. - * This endpoint fetches the unlinked PA template type details. - * @param id Unique identifier for an unlinked PA template type (required) - @return UnlinkedPATemplateCategoryAndTypeDetailsRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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 UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(String id) throws ApiException { - return getDetailsTypeWithHttpInfo(id).getData(); - } - - /** - * Get unlinked PA template type details by id. - * This endpoint fetches the unlinked PA template type details. - * @param id Unique identifier for an unlinked PA template type (required) - * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeDetailsRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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 getDetailsTypeWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getDetailsType"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("UnlinkedPaTemplatesApi.getDetailsType", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get unlinked PA templates - * This endpoint returns the list of unlinked PA templates. - * @param directory Get unlinked PA templates in path. (optional) - * @param category Get unlinked PA templates by category. (optional) - @return UnlinkedPATemplateSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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 UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(String directory, String category) throws ApiException { - return getUnlinkedPATemplatesWithHttpInfo(directory, category).getData(); - } - - /** - * Get unlinked PA templates - * This endpoint returns the list of unlinked PA templates. - * @param directory Get unlinked PA templates in path. (optional) - * @param category Get unlinked PA templates by category. (optional) - * @return ApiResponse<UnlinkedPATemplateSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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 getUnlinkedPATemplatesWithHttpInfo(String directory, String category) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; - - // 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("", "directory", directory)); - localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); - - - - - 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(){}); - - return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getUnlinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get unlinked PA template details by id - * This endpoint fetches the template settings. - * @param id Unique identifier for an unlinked PA template (required) - @return UnlinkedPATemplateRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
- */ - public UnlinkedPATemplateRoot getUnlinkedPATemplatesById(String id) throws ApiException { - return getUnlinkedPATemplatesByIdWithHttpInfo(id).getData(); - } - - /** - * Get unlinked PA template details by id - * This endpoint fetches the template settings. - * @param id Unique identifier for an unlinked PA template (required) - * @return ApiResponse<UnlinkedPATemplateRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
- */ - public ApiResponse getUnlinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getUnlinkedPATemplatesById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("UnlinkedPaTemplatesApi.getUnlinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Update unlinked PA template - * This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param id Unique identifier for an unlinked PA template (required) - * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) - @return UnlinkedPATemplatePostSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
- */ - public UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { - return updateUnlinkedPATemplatesWithHttpInfo(id, unlinkedPATemplateUpdateParametersRoot).getData(); - } - - /** - * Update unlinked PA template - * This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - * @param id Unique identifier for an unlinked PA template (required) - * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) - * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, updated the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
- */ - public ApiResponse updateUnlinkedPATemplatesWithHttpInfo(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { - Object localVarPostBody = unlinkedPATemplateUpdateParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling updateUnlinkedPATemplates"); - } - - // verify the required parameter 'unlinkedPATemplateUpdateParametersRoot' is set - if (unlinkedPATemplateUpdateParametersRoot == null) { - throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateUpdateParametersRoot' when calling updateUnlinkedPATemplates"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { - "application/json" - }; - 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("UnlinkedPaTemplatesApi.updateUnlinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java similarity index 59% rename from auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java rename to auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java index a61800f7..893e79fa 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java @@ -14,16 +14,18 @@ import java.io.File; -import factset.analyticsapi.engines.models.ColumnStatisticRoot; +import factset.analyticsapi.engines.models.ClientErrorResponse; +import java.io.File; +import factset.analyticsapi.engines.models.VaultAttributionLoaderResponseRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnStatisticsApi { +public class VaultAttributionLoaderApi { private ApiClient apiClient; - public ColumnStatisticsApi() { + public VaultAttributionLoaderApi() { this(Configuration.getDefaultApiClient()); } - public ColumnStatisticsApi(ApiClient apiClient) { + public VaultAttributionLoaderApi(ApiClient apiClient) { this.apiClient = apiClient; } @@ -46,48 +48,60 @@ public void setApiClient(ApiClient apiClient) { } /** - * Get PA column statistics - * This endpoint lists all the column statistics that can be applied to a PA column. - @return ColumnStatisticRoot + * Vault - External Attribution Loader + * This endpoint loads Vault External Attributions. + * @param batchId (required) + * @param file (optional) + @return VaultAttributionLoaderResponseRoot * @throws ApiException if fails to make API call * @http.response.details - + + - +
Status Code Description Response Headers
200 Expected response, returns a list of PA column statistics * 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.
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.
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 ColumnStatisticRoot getPAColumnStatistics() throws ApiException { - return getPAColumnStatisticsWithHttpInfo().getData(); + public VaultAttributionLoaderResponseRoot vaultAttributionLoader(String batchId, File file) throws ApiException { + return vaultAttributionLoaderWithHttpInfo(batchId, file).getData(); } /** - * Get PA column statistics - * This endpoint lists all the column statistics that can be applied to a PA column. - * @return ApiResponse<ColumnStatisticRoot> + * Vault - External Attribution Loader + * This endpoint loads Vault External Attributions. + * @param batchId (required) + * @param file (optional) + * @return ApiResponse<VaultAttributionLoaderResponseRoot> * @throws ApiException if fails to make API call * @http.response.details - + + - +
Status Code Description Response Headers
200 Expected response, returns a list of PA column statistics * 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.
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.
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 getPAColumnStatisticsWithHttpInfo() throws ApiException { + public ApiResponse vaultAttributionLoaderWithHttpInfo(String batchId, File file) throws ApiException { Object localVarPostBody = null; + // verify the required parameter 'batchId' is set + if (batchId == null) { + throw new ApiException(400, "Missing the required parameter 'batchId' when calling vaultAttributionLoader"); + } + // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/columnstatistics"; + String localVarPath = "/analytics/engines/vault/v3/load/{batchId}" + .replaceAll("\\{" + "batchId" + "\\}", apiClient.escapeString(batchId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); @@ -98,25 +112,28 @@ public ApiResponse getPAColumnStatisticsWithHttpInfo() thro - + if (file != null) + localVarFormParams.put("file", file); + final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { - + "multipart/form-data" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - GenericType localVarReturnType = new GenericType() {}; + GenericType localVarReturnType = new GenericType() {}; Map returnTypeMap = new HashMap(); - returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); - return apiClient.invokeAPIWithReturnMap("ColumnStatisticsApi.getPAColumnStatistics", localVarPath, "GET", localVarQueryParams, localVarPostBody, + return apiClient.invokeAPIWithReturnMap("VaultAttributionLoaderApi.vaultAttributionLoader", localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index af10462e..305e32da 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "text/plain", "application/json", "text/json" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java index 6d11e29e..d8573bf7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java @@ -30,8 +30,9 @@ /** - * AccountDirectories + * List of the accounts and directories. */ +@ApiModel(description = "List of the accounts and directories.") @JsonPropertyOrder({ AccountDirectories.JSON_PROPERTY_ACCOUNTS, AccountDirectories.JSON_PROPERTY_DIRECTORIES diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java index 6b7dd2ff..45f3410d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java @@ -31,8 +31,9 @@ /** - * CalculationStatus + * Details of the calculation. */ +@ApiModel(description = "Details of the calculation.") @JsonPropertyOrder({ CalculationStatus.JSON_PROPERTY_CALCULATIONID, CalculationStatus.JSON_PROPERTY_STATUS, diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java index 0205601d..5b4d1164 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java @@ -31,8 +31,9 @@ /** - * CalculationStatusMeta + * Meta of calculation units in batch. */ +@ApiModel(description = "Meta of calculation units in batch.") @JsonPropertyOrder({ CalculationStatusMeta.JSON_PROPERTY_UNITS }) @@ -58,11 +59,11 @@ public CalculationStatusMeta putUnitsItem(String key, CalculationUnitStatusMeta } /** - * Meta of calculation units in batch. + * List of calculation units in batch. * @return units **/ @javax.annotation.Nullable - @ApiModelProperty(value = "Meta of calculation units in batch.") + @ApiModelProperty(value = "List of calculation units in batch.") @JsonProperty(JSON_PROPERTY_UNITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java index 82fd76fb..9d7a4f6e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java @@ -31,8 +31,9 @@ /** - * CalculationUnitStatus + * The status of the calculation as per FactSets API standards */ +@ApiModel(description = "The status of the calculation as per FactSets API standards") @JsonPropertyOrder({ CalculationUnitStatus.JSON_PROPERTY_STATUS, CalculationUnitStatus.JSON_PROPERTY_ERRORS, diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java index f3bb9c81..1763449b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java @@ -30,8 +30,9 @@ /** - * CalculationUnitStatusMeta + * Meta of the calculation unit. */ +@ApiModel(description = "Meta of the calculation unit.") @JsonPropertyOrder({ CalculationUnitStatusMeta.JSON_PROPERTY_INFO }) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java deleted file mode 100644 index 88b4cab4..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java +++ /dev/null @@ -1,209 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * Column - */ -@JsonPropertyOrder({ - Column.JSON_PROPERTY_DEFAULTSTATISTICSIDS, - Column.JSON_PROPERTY_NAME, - Column.JSON_PROPERTY_DIRECTORY, - Column.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class Column implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DEFAULTSTATISTICSIDS = "defaultstatisticsids"; - private java.util.List defaultstatisticsids = null; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public Column defaultstatisticsids(java.util.List defaultstatisticsids) { - this.defaultstatisticsids = defaultstatisticsids; - return this; - } - - public Column addDefaultstatisticsidsItem(String defaultstatisticsidsItem) { - if (this.defaultstatisticsids == null) { - this.defaultstatisticsids = new java.util.ArrayList(); - } - this.defaultstatisticsids.add(defaultstatisticsidsItem); - return this; - } - - /** - * Column statistic Id - * @return defaultstatisticsids - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column statistic Id") - @JsonProperty(JSON_PROPERTY_DEFAULTSTATISTICSIDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getDefaultstatisticsids() { - return defaultstatisticsids; - } - - - public void setDefaultstatisticsids(java.util.List defaultstatisticsids) { - this.defaultstatisticsids = defaultstatisticsids; - } - - - public Column name(String name) { - this.name = name; - return this; - } - - /** - * Column Name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public Column directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Column Directory - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Directory") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public Column category(String category) { - this.category = category; - return this; - } - - /** - * Column Category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this Column object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Column column = (Column) o; - return Objects.equals(this.defaultstatisticsids, column.defaultstatisticsids) && - Objects.equals(this.name, column.name) && - Objects.equals(this.directory, column.directory) && - Objects.equals(this.category, column.category); - } - - @Override - public int hashCode() { - return Objects.hash(defaultstatisticsids, name, directory, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Column {\n"); - sb.append(" defaultstatisticsids: ").append(toIndentedString(defaultstatisticsids)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java deleted file mode 100644 index 082bb979..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.Column; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * ColumnRoot - */ -@JsonPropertyOrder({ - ColumnRoot.JSON_PROPERTY_DATA, - ColumnRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private Column data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public ColumnRoot data(Column data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public Column getData() { - return data; - } - - - public void setData(Column data) { - this.data = data; - } - - - public ColumnRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this ColumnRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ColumnRoot columnRoot = (ColumnRoot) o; - return Objects.equals(this.data, columnRoot.data) && - Objects.equals(this.meta, columnRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ColumnRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java deleted file mode 100644 index 400a58b9..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * ColumnStatistic - */ -@JsonPropertyOrder({ - ColumnStatistic.JSON_PROPERTY_NAME -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnStatistic implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - - public ColumnStatistic name(String name) { - this.name = name; - return this; - } - - /** - * Column Statistic Name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Statistic Name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - /** - * Return true if this ColumnStatistic object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ColumnStatistic columnStatistic = (ColumnStatistic) o; - return Objects.equals(this.name, columnStatistic.name); - } - - @Override - public int hashCode() { - return Objects.hash(name); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ColumnStatistic {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java deleted file mode 100644 index 17e2db55..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.ColumnStatistic; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * ColumnStatisticRoot - */ -@JsonPropertyOrder({ - ColumnStatisticRoot.JSON_PROPERTY_DATA, - ColumnStatisticRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnStatisticRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public ColumnStatisticRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public ColumnStatisticRoot putDataItem(String key, ColumnStatistic dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public ColumnStatisticRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this ColumnStatisticRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ColumnStatisticRoot columnStatisticRoot = (ColumnStatisticRoot) o; - return Objects.equals(this.data, columnStatisticRoot.data) && - Objects.equals(this.meta, columnStatisticRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ColumnStatisticRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java deleted file mode 100644 index 3e4751cf..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java +++ /dev/null @@ -1,172 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * Column settings (name, directory, category) - */ -@ApiModel(description = "Column settings (name, directory, category)") -@JsonPropertyOrder({ - ColumnSummary.JSON_PROPERTY_NAME, - ColumnSummary.JSON_PROPERTY_DIRECTORY, - ColumnSummary.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public ColumnSummary name(String name) { - this.name = name; - return this; - } - - /** - * Column Name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public ColumnSummary directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Column Directory - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Directory") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public ColumnSummary category(String category) { - this.category = category; - return this; - } - - /** - * Column Category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this ColumnSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ColumnSummary columnSummary = (ColumnSummary) o; - return Objects.equals(this.name, columnSummary.name) && - Objects.equals(this.directory, columnSummary.directory) && - Objects.equals(this.category, columnSummary.category); - } - - @Override - public int hashCode() { - return Objects.hash(name, directory, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ColumnSummary {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java deleted file mode 100644 index b176741b..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.ColumnSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * ColumnSummaryRoot - */ -@JsonPropertyOrder({ - ColumnSummaryRoot.JSON_PROPERTY_DATA, - ColumnSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class ColumnSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public ColumnSummaryRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public ColumnSummaryRoot putDataItem(String key, ColumnSummary dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public ColumnSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this ColumnSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ColumnSummaryRoot columnSummaryRoot = (ColumnSummaryRoot) o; - return Objects.equals(this.data, columnSummaryRoot.data) && - Objects.equals(this.meta, columnSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ColumnSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java index 692addf0..6ff181d1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java @@ -30,8 +30,9 @@ /** - * Currency + * Details of the currency. */ +@ApiModel(description = "Details of the currency.") @JsonPropertyOrder({ Currency.JSON_PROPERTY_NAME }) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java new file mode 100644 index 00000000..fdc2c684 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java @@ -0,0 +1,298 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FIConvertibleSettings + */ +@JsonPropertyOrder({ + FIConvertibleSettings.JSON_PROPERTY_EQUITY_PRICE, + FIConvertibleSettings.JSON_PROPERTY_EQUITY_INDEX_VOLATILITY, + FIConvertibleSettings.JSON_PROPERTY_EQUITY_DIVIDEND_YIELD, + FIConvertibleSettings.JSON_PROPERTY_VOLATILITY_CAP_METHOD, + FIConvertibleSettings.JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE, + FIConvertibleSettings.JSON_PROPERTY_EQUITY_EXCHANGE_RATE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIConvertibleSettings implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_EQUITY_PRICE = "equityPrice"; + private Double equityPrice; + + public static final String JSON_PROPERTY_EQUITY_INDEX_VOLATILITY = "equityIndexVolatility"; + private Double equityIndexVolatility; + + public static final String JSON_PROPERTY_EQUITY_DIVIDEND_YIELD = "equityDividendYield"; + private Double equityDividendYield; + + /** + * Volatility CapMethod + */ + public enum VolatilityCapMethodEnum { + NOCAP("noCap"), + + SPECIFIEDRATE("specifiedRate"), + + MULTIPLIER("multiplier"); + + private String value; + + VolatilityCapMethodEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static VolatilityCapMethodEnum fromValue(String value) { + for (VolatilityCapMethodEnum b : VolatilityCapMethodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_VOLATILITY_CAP_METHOD = "volatilityCapMethod"; + private VolatilityCapMethodEnum volatilityCapMethod; + + public static final String JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE = "volatilityCapMethodValue"; + private Double volatilityCapMethodValue; + + public static final String JSON_PROPERTY_EQUITY_EXCHANGE_RATE = "equityExchangeRate"; + private Double equityExchangeRate; + + + public FIConvertibleSettings equityPrice(Double equityPrice) { + this.equityPrice = equityPrice; + return this; + } + + /** + * Equity Price + * @return equityPrice + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Equity Price") + @JsonProperty(JSON_PROPERTY_EQUITY_PRICE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEquityPrice() { + return equityPrice; + } + + + public void setEquityPrice(Double equityPrice) { + this.equityPrice = equityPrice; + } + + + public FIConvertibleSettings equityIndexVolatility(Double equityIndexVolatility) { + this.equityIndexVolatility = equityIndexVolatility; + return this; + } + + /** + * Equity Index Volatility + * @return equityIndexVolatility + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Equity Index Volatility") + @JsonProperty(JSON_PROPERTY_EQUITY_INDEX_VOLATILITY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEquityIndexVolatility() { + return equityIndexVolatility; + } + + + public void setEquityIndexVolatility(Double equityIndexVolatility) { + this.equityIndexVolatility = equityIndexVolatility; + } + + + public FIConvertibleSettings equityDividendYield(Double equityDividendYield) { + this.equityDividendYield = equityDividendYield; + return this; + } + + /** + * Equity Dividend Yield + * @return equityDividendYield + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Equity Dividend Yield") + @JsonProperty(JSON_PROPERTY_EQUITY_DIVIDEND_YIELD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEquityDividendYield() { + return equityDividendYield; + } + + + public void setEquityDividendYield(Double equityDividendYield) { + this.equityDividendYield = equityDividendYield; + } + + + public FIConvertibleSettings volatilityCapMethod(VolatilityCapMethodEnum volatilityCapMethod) { + this.volatilityCapMethod = volatilityCapMethod; + return this; + } + + /** + * Volatility CapMethod + * @return volatilityCapMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Volatility CapMethod") + @JsonProperty(JSON_PROPERTY_VOLATILITY_CAP_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public VolatilityCapMethodEnum getVolatilityCapMethod() { + return volatilityCapMethod; + } + + + public void setVolatilityCapMethod(VolatilityCapMethodEnum volatilityCapMethod) { + this.volatilityCapMethod = volatilityCapMethod; + } + + + public FIConvertibleSettings volatilityCapMethodValue(Double volatilityCapMethodValue) { + this.volatilityCapMethodValue = volatilityCapMethodValue; + return this; + } + + /** + * Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) + * @return volatilityCapMethodValue + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier)") + @JsonProperty(JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getVolatilityCapMethodValue() { + return volatilityCapMethodValue; + } + + + public void setVolatilityCapMethodValue(Double volatilityCapMethodValue) { + this.volatilityCapMethodValue = volatilityCapMethodValue; + } + + + public FIConvertibleSettings equityExchangeRate(Double equityExchangeRate) { + this.equityExchangeRate = equityExchangeRate; + return this; + } + + /** + * Equity Exchange Rate + * @return equityExchangeRate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Equity Exchange Rate") + @JsonProperty(JSON_PROPERTY_EQUITY_EXCHANGE_RATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEquityExchangeRate() { + return equityExchangeRate; + } + + + public void setEquityExchangeRate(Double equityExchangeRate) { + this.equityExchangeRate = equityExchangeRate; + } + + + /** + * Return true if this FIConvertibleSettings object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIConvertibleSettings fiConvertibleSettings = (FIConvertibleSettings) o; + return Objects.equals(this.equityPrice, fiConvertibleSettings.equityPrice) && + Objects.equals(this.equityIndexVolatility, fiConvertibleSettings.equityIndexVolatility) && + Objects.equals(this.equityDividendYield, fiConvertibleSettings.equityDividendYield) && + Objects.equals(this.volatilityCapMethod, fiConvertibleSettings.volatilityCapMethod) && + Objects.equals(this.volatilityCapMethodValue, fiConvertibleSettings.volatilityCapMethodValue) && + Objects.equals(this.equityExchangeRate, fiConvertibleSettings.equityExchangeRate); + } + + @Override + public int hashCode() { + return Objects.hash(equityPrice, equityIndexVolatility, equityDividendYield, volatilityCapMethod, volatilityCapMethodValue, equityExchangeRate); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIConvertibleSettings {\n"); + sb.append(" equityPrice: ").append(toIndentedString(equityPrice)).append("\n"); + sb.append(" equityIndexVolatility: ").append(toIndentedString(equityIndexVolatility)).append("\n"); + sb.append(" equityDividendYield: ").append(toIndentedString(equityDividendYield)).append("\n"); + sb.append(" volatilityCapMethod: ").append(toIndentedString(volatilityCapMethod)).append("\n"); + sb.append(" volatilityCapMethodValue: ").append(toIndentedString(volatilityCapMethodValue)).append("\n"); + sb.append(" equityExchangeRate: ").append(toIndentedString(equityExchangeRate)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java index a78bfe03..4f67fb66 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java @@ -24,6 +24,7 @@ import com.fasterxml.jackson.annotation.JsonValue; import factset.analyticsapi.engines.models.FIAttributionForSecurities; import factset.analyticsapi.engines.models.FIBankLoans; +import factset.analyticsapi.engines.models.FIConvertibleSettings; import factset.analyticsapi.engines.models.FILoss; import factset.analyticsapi.engines.models.FIMunicipalBonds; import factset.analyticsapi.engines.models.FIPrepay; @@ -51,6 +52,7 @@ FISecurity.JSON_PROPERTY_MATRIX_MULTIPLIER, FISecurity.JSON_PROPERTY_STRUCTURED_PRODUCTS, FISecurity.JSON_PROPERTY_ATTRIBUTION, + FISecurity.JSON_PROPERTY_CONVERTIBLE, FISecurity.JSON_PROPERTY_CALC_FROM_METHOD, FISecurity.JSON_PROPERTY_CALC_FROM_VALUE, FISecurity.JSON_PROPERTY_FACE, @@ -134,6 +136,9 @@ public static CallMethodEnum fromValue(String value) { public static final String JSON_PROPERTY_ATTRIBUTION = "attribution"; private FIAttributionForSecurities attribution; + public static final String JSON_PROPERTY_CONVERTIBLE = "convertible"; + private FIConvertibleSettings convertible; + public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; private String calcFromMethod; @@ -452,6 +457,30 @@ public void setAttribution(FIAttributionForSecurities attribution) { } + public FISecurity convertible(FIConvertibleSettings convertible) { + this.convertible = convertible; + return this; + } + + /** + * Get convertible + * @return convertible + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONVERTIBLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIConvertibleSettings getConvertible() { + return convertible; + } + + + public void setConvertible(FIConvertibleSettings convertible) { + this.convertible = convertible; + } + + public FISecurity calcFromMethod(String calcFromMethod) { this.calcFromMethod = calcFromMethod; return this; @@ -617,6 +646,7 @@ public boolean equals(Object o) { Objects.equals(this.matrixMultiplier, fiSecurity.matrixMultiplier) && Objects.equals(this.structuredProducts, fiSecurity.structuredProducts) && Objects.equals(this.attribution, fiSecurity.attribution) && + Objects.equals(this.convertible, fiSecurity.convertible) && Objects.equals(this.calcFromMethod, fiSecurity.calcFromMethod) && Objects.equals(this.calcFromValue, fiSecurity.calcFromValue) && Objects.equals(this.face, fiSecurity.face) && @@ -627,7 +657,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(settlement, callMethod, referenceSecurity, bankLoans, municipalBonds, loss, prepay, matrixSpreadAdjustment, matrixMultiplier, structuredProducts, attribution, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); + return Objects.hash(settlement, callMethod, referenceSecurity, bankLoans, municipalBonds, loss, prepay, matrixSpreadAdjustment, matrixMultiplier, structuredProducts, attribution, convertible, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); } @Override @@ -645,6 +675,7 @@ public String toString() { sb.append(" matrixMultiplier: ").append(toIndentedString(matrixMultiplier)).append("\n"); sb.append(" structuredProducts: ").append(toIndentedString(structuredProducts)).append("\n"); sb.append(" attribution: ").append(toIndentedString(attribution)).append("\n"); + sb.append(" convertible: ").append(toIndentedString(convertible)).append("\n"); sb.append(" calcFromMethod: ").append(toIndentedString(calcFromMethod)).append("\n"); sb.append(" calcFromValue: ").append(toIndentedString(calcFromValue)).append("\n"); sb.append(" face: ").append(toIndentedString(face)).append("\n"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java deleted file mode 100644 index fb6bdcc3..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java +++ /dev/null @@ -1,172 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.OptimizerAccountOverrides; -import factset.analyticsapi.engines.models.PaDoc; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOAccount - */ -@JsonPropertyOrder({ - FPOAccount.JSON_PROPERTY_PA_DOCUMENT, - FPOAccount.JSON_PROPERTY_ID, - FPOAccount.JSON_PROPERTY_OVERRIDES -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOAccount implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_PA_DOCUMENT = "paDocument"; - private PaDoc paDocument; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_OVERRIDES = "overrides"; - private OptimizerAccountOverrides overrides; - - - public FPOAccount paDocument(PaDoc paDocument) { - this.paDocument = paDocument; - return this; - } - - /** - * Get paDocument - * @return paDocument - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_PA_DOCUMENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PaDoc getPaDocument() { - return paDocument; - } - - - public void setPaDocument(PaDoc paDocument) { - this.paDocument = paDocument; - } - - - public FPOAccount id(String id) { - this.id = id; - return this; - } - - /** - * Account path - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Account path") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public FPOAccount overrides(OptimizerAccountOverrides overrides) { - this.overrides = overrides; - return this; - } - - /** - * Get overrides - * @return overrides - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OVERRIDES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OptimizerAccountOverrides getOverrides() { - return overrides; - } - - - public void setOverrides(OptimizerAccountOverrides overrides) { - this.overrides = overrides; - } - - - /** - * Return true if this FPOAccount object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOAccount fpOAccount = (FPOAccount) o; - return Objects.equals(this.paDocument, fpOAccount.paDocument) && - Objects.equals(this.id, fpOAccount.id) && - Objects.equals(this.overrides, fpOAccount.overrides); - } - - @Override - public int hashCode() { - return Objects.hash(paDocument, id, overrides); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOAccount {\n"); - sb.append(" paDocument: ").append(toIndentedString(paDocument)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" overrides: ").append(toIndentedString(overrides)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java deleted file mode 100644 index b8824fb2..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java +++ /dev/null @@ -1,184 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOObjective - */ -@JsonPropertyOrder({ - FPOObjective.JSON_PROPERTY_ACTIVE, - FPOObjective.JSON_PROPERTY_TERMS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOObjective implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ACTIVE = "active"; - private String active; - - /** - * Gets or Sets inner - */ - public enum InnerEnum { - DISABLE("Disable"), - - ENABLE("Enable"); - - private String value; - - InnerEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static InnerEnum fromValue(String value) { - for (InnerEnum b : InnerEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_TERMS = "terms"; - private java.util.Map terms = null; - - - public FPOObjective active(String active) { - this.active = active; - return this; - } - - /** - * Get active - * @return active - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_ACTIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getActive() { - return active; - } - - - public void setActive(String active) { - this.active = active; - } - - - public FPOObjective terms(java.util.Map terms) { - this.terms = terms; - return this; - } - - public FPOObjective putTermsItem(String key, InnerEnum termsItem) { - if (this.terms == null) { - this.terms = new java.util.HashMap(); - } - this.terms.put(key, termsItem); - return this; - } - - /** - * Get terms - * @return terms - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_TERMS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.Map getTerms() { - return terms; - } - - - public void setTerms(java.util.Map terms) { - this.terms = terms; - } - - - /** - * Return true if this FPOObjective object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOObjective fpOObjective = (FPOObjective) o; - return Objects.equals(this.active, fpOObjective.active) && - Objects.equals(this.terms, fpOObjective.terms); - } - - @Override - public int hashCode() { - return Objects.hash(active, terms); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOObjective {\n"); - sb.append(" active: ").append(toIndentedString(active)).append("\n"); - sb.append(" terms: ").append(toIndentedString(terms)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java deleted file mode 100644 index c126f314..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java +++ /dev/null @@ -1,203 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.FPOAccount; -import factset.analyticsapi.engines.models.FPOOptimizerStrategy; -import factset.analyticsapi.engines.models.Optimization; -import factset.analyticsapi.engines.models.OptimizerOutputTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOOptimizationParameters - */ -@JsonPropertyOrder({ - FPOOptimizationParameters.JSON_PROPERTY_ACCOUNT, - FPOOptimizationParameters.JSON_PROPERTY_STRATEGY, - FPOOptimizationParameters.JSON_PROPERTY_OPTIMIZATION, - FPOOptimizationParameters.JSON_PROPERTY_OUTPUT_TYPES -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOOptimizationParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ACCOUNT = "account"; - private FPOAccount account; - - public static final String JSON_PROPERTY_STRATEGY = "strategy"; - private FPOOptimizerStrategy strategy; - - public static final String JSON_PROPERTY_OPTIMIZATION = "optimization"; - private Optimization optimization; - - public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; - private OptimizerOutputTypes outputTypes; - - - public FPOOptimizationParameters account(FPOAccount account) { - this.account = account; - return this; - } - - /** - * Get account - * @return account - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public FPOAccount getAccount() { - return account; - } - - - public void setAccount(FPOAccount account) { - this.account = account; - } - - - public FPOOptimizationParameters strategy(FPOOptimizerStrategy strategy) { - this.strategy = strategy; - return this; - } - - /** - * Get strategy - * @return strategy - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_STRATEGY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public FPOOptimizerStrategy getStrategy() { - return strategy; - } - - - public void setStrategy(FPOOptimizerStrategy strategy) { - this.strategy = strategy; - } - - - public FPOOptimizationParameters optimization(Optimization optimization) { - this.optimization = optimization; - return this; - } - - /** - * Get optimization - * @return optimization - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OPTIMIZATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Optimization getOptimization() { - return optimization; - } - - - public void setOptimization(Optimization optimization) { - this.optimization = optimization; - } - - - public FPOOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { - this.outputTypes = outputTypes; - return this; - } - - /** - * Get outputTypes - * @return outputTypes - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public OptimizerOutputTypes getOutputTypes() { - return outputTypes; - } - - - public void setOutputTypes(OptimizerOutputTypes outputTypes) { - this.outputTypes = outputTypes; - } - - - /** - * Return true if this FPOOptimizationParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOOptimizationParameters fpOOptimizationParameters = (FPOOptimizationParameters) o; - return Objects.equals(this.account, fpOOptimizationParameters.account) && - Objects.equals(this.strategy, fpOOptimizationParameters.strategy) && - Objects.equals(this.optimization, fpOOptimizationParameters.optimization) && - Objects.equals(this.outputTypes, fpOOptimizationParameters.outputTypes); - } - - @Override - public int hashCode() { - return Objects.hash(account, strategy, optimization, outputTypes); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOOptimizationParameters {\n"); - sb.append(" account: ").append(toIndentedString(account)).append("\n"); - sb.append(" strategy: ").append(toIndentedString(strategy)).append("\n"); - sb.append(" optimization: ").append(toIndentedString(optimization)).append("\n"); - sb.append(" outputTypes: ").append(toIndentedString(outputTypes)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java deleted file mode 100644 index 431858b5..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.FPOOptimizationParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOOptimizationParametersRoot - */ -@JsonPropertyOrder({ - FPOOptimizationParametersRoot.JSON_PROPERTY_DATA, - FPOOptimizationParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOOptimizationParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private FPOOptimizationParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public FPOOptimizationParametersRoot data(FPOOptimizationParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public FPOOptimizationParameters getData() { - return data; - } - - - public void setData(FPOOptimizationParameters data) { - this.data = data; - } - - - public FPOOptimizationParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this FPOOptimizationParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOOptimizationParametersRoot fpOOptimizationParametersRoot = (FPOOptimizationParametersRoot) o; - return Objects.equals(this.data, fpOOptimizationParametersRoot.data) && - Objects.equals(this.meta, fpOOptimizationParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOOptimizationParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java deleted file mode 100644 index 914447ab..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.FPOOptimizerStrategyOverrides; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOOptimizerStrategy - */ -@JsonPropertyOrder({ - FPOOptimizerStrategy.JSON_PROPERTY_OVERRIDES, - FPOOptimizerStrategy.JSON_PROPERTY_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOOptimizerStrategy implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_OVERRIDES = "overrides"; - private FPOOptimizerStrategyOverrides overrides; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - - public FPOOptimizerStrategy overrides(FPOOptimizerStrategyOverrides overrides) { - this.overrides = overrides; - return this; - } - - /** - * Get overrides - * @return overrides - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OVERRIDES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public FPOOptimizerStrategyOverrides getOverrides() { - return overrides; - } - - - public void setOverrides(FPOOptimizerStrategyOverrides overrides) { - this.overrides = overrides; - } - - - public FPOOptimizerStrategy id(String id) { - this.id = id; - return this; - } - - /** - * OptimizerStrategy document path - * @return id - **/ - @ApiModelProperty(required = true, value = "OptimizerStrategy document path") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - /** - * Return true if this FPOOptimizerStrategy object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOOptimizerStrategy fpOOptimizerStrategy = (FPOOptimizerStrategy) o; - return Objects.equals(this.overrides, fpOOptimizerStrategy.overrides) && - Objects.equals(this.id, fpOOptimizerStrategy.id); - } - - @Override - public int hashCode() { - return Objects.hash(overrides, id); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOOptimizerStrategy {\n"); - sb.append(" overrides: ").append(toIndentedString(overrides)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java deleted file mode 100644 index 8ab92107..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java +++ /dev/null @@ -1,245 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.FPOObjective; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FPOOptimizerStrategyOverrides - */ -@JsonPropertyOrder({ - FPOOptimizerStrategyOverrides.JSON_PROPERTY_OBJECTIVE, - FPOOptimizerStrategyOverrides.JSON_PROPERTY_CONSTRAINTS, - FPOOptimizerStrategyOverrides.JSON_PROPERTY_ALPHA, - FPOOptimizerStrategyOverrides.JSON_PROPERTY_TRANSACTION_COST -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FPOOptimizerStrategyOverrides implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_OBJECTIVE = "objective"; - private FPOObjective objective; - - /** - * Gets or Sets inner - */ - public enum InnerEnum { - DISABLE("Disable"), - - ENABLE("Enable"); - - private String value; - - InnerEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static InnerEnum fromValue(String value) { - for (InnerEnum b : InnerEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_CONSTRAINTS = "constraints"; - private java.util.Map constraints = null; - - public static final String JSON_PROPERTY_ALPHA = "alpha"; - private String alpha; - - public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; - private String transactionCost; - - - public FPOOptimizerStrategyOverrides objective(FPOObjective objective) { - this.objective = objective; - return this; - } - - /** - * Get objective - * @return objective - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OBJECTIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public FPOObjective getObjective() { - return objective; - } - - - public void setObjective(FPOObjective objective) { - this.objective = objective; - } - - - public FPOOptimizerStrategyOverrides constraints(java.util.Map constraints) { - this.constraints = constraints; - return this; - } - - public FPOOptimizerStrategyOverrides putConstraintsItem(String key, InnerEnum constraintsItem) { - if (this.constraints == null) { - this.constraints = new java.util.HashMap(); - } - this.constraints.put(key, constraintsItem); - return this; - } - - /** - * List of constraints - * @return constraints - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of constraints") - @JsonProperty(JSON_PROPERTY_CONSTRAINTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.Map getConstraints() { - return constraints; - } - - - public void setConstraints(java.util.Map constraints) { - this.constraints = constraints; - } - - - public FPOOptimizerStrategyOverrides alpha(String alpha) { - this.alpha = alpha; - return this; - } - - /** - * Alpha - * @return alpha - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Alpha") - @JsonProperty(JSON_PROPERTY_ALPHA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAlpha() { - return alpha; - } - - - public void setAlpha(String alpha) { - this.alpha = alpha; - } - - - public FPOOptimizerStrategyOverrides transactionCost(String transactionCost) { - this.transactionCost = transactionCost; - return this; - } - - /** - * Transaction cost - * @return transactionCost - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Transaction cost") - @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTransactionCost() { - return transactionCost; - } - - - public void setTransactionCost(String transactionCost) { - this.transactionCost = transactionCost; - } - - - /** - * Return true if this FPOOptimizerStrategyOverrides object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FPOOptimizerStrategyOverrides fpOOptimizerStrategyOverrides = (FPOOptimizerStrategyOverrides) o; - return Objects.equals(this.objective, fpOOptimizerStrategyOverrides.objective) && - Objects.equals(this.constraints, fpOOptimizerStrategyOverrides.constraints) && - Objects.equals(this.alpha, fpOOptimizerStrategyOverrides.alpha) && - Objects.equals(this.transactionCost, fpOOptimizerStrategyOverrides.transactionCost); - } - - @Override - public int hashCode() { - return Objects.hash(objective, constraints, alpha, transactionCost); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FPOOptimizerStrategyOverrides {\n"); - sb.append(" objective: ").append(toIndentedString(objective)).append("\n"); - sb.append(" constraints: ").append(toIndentedString(constraints)).append("\n"); - sb.append(" alpha: ").append(toIndentedString(alpha)).append("\n"); - sb.append(" transactionCost: ").append(toIndentedString(transactionCost)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java deleted file mode 100644 index 4f2cdfad..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * Group - */ -@JsonPropertyOrder({ - Group.JSON_PROPERTY_NAME, - Group.JSON_PROPERTY_DIRECTORY, - Group.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class Group implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public Group name(String name) { - this.name = name; - return this; - } - - /** - * Group Name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Group Name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public Group directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Group Directory - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Group Directory") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public Group category(String category) { - this.category = category; - return this; - } - - /** - * Group Category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Group Category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this Group object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Group group = (Group) o; - return Objects.equals(this.name, group.name) && - Objects.equals(this.directory, group.directory) && - Objects.equals(this.category, group.category); - } - - @Override - public int hashCode() { - return Objects.hash(name, directory, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Group {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java deleted file mode 100644 index 6e03e440..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.Group; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * GroupRoot - */ -@JsonPropertyOrder({ - GroupRoot.JSON_PROPERTY_DATA, - GroupRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class GroupRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public GroupRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public GroupRoot putDataItem(String key, Group dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public GroupRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this GroupRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - GroupRoot groupRoot = (GroupRoot) o; - return Objects.equals(this.data, groupRoot.data) && - Objects.equals(this.meta, groupRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class GroupRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java deleted file mode 100644 index a6b394a1..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java +++ /dev/null @@ -1,292 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplate - */ -@JsonPropertyOrder({ - LinkedPATemplate.JSON_PROPERTY_DIRECTORY, - LinkedPATemplate.JSON_PROPERTY_SNAPSHOT, - LinkedPATemplate.JSON_PROPERTY_CONTENT, - LinkedPATemplate.JSON_PROPERTY_ID, - LinkedPATemplate.JSON_PROPERTY_DESCRIPTION, - LinkedPATemplate.JSON_PROPERTY_NAME, - LinkedPATemplate.JSON_PROPERTY_PARENT_COMPONENT_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplate implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; - private Boolean snapshot; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; - private String parentComponentId; - - - public LinkedPATemplate directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Template directory. - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template directory.") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public LinkedPATemplate snapshot(Boolean snapshot) { - this.snapshot = snapshot; - return this; - } - - /** - * snapshot. - * @return snapshot - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "snapshot.") - @JsonProperty(JSON_PROPERTY_SNAPSHOT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSnapshot() { - return snapshot; - } - - - public void setSnapshot(Boolean snapshot) { - this.snapshot = snapshot; - } - - - public LinkedPATemplate content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - public LinkedPATemplate id(String id) { - this.id = id; - return this; - } - - /** - * Template id. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template id.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public LinkedPATemplate description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public LinkedPATemplate name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public LinkedPATemplate parentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - return this; - } - - /** - * Template parent tile. - * @return parentComponentId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template parent tile.") - @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentComponentId() { - return parentComponentId; - } - - - public void setParentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - } - - - /** - * Return true if this LinkedPATemplate object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplate linkedPATemplate = (LinkedPATemplate) o; - return Objects.equals(this.directory, linkedPATemplate.directory) && - Objects.equals(this.snapshot, linkedPATemplate.snapshot) && - Objects.equals(this.content, linkedPATemplate.content) && - Objects.equals(this.id, linkedPATemplate.id) && - Objects.equals(this.description, linkedPATemplate.description) && - Objects.equals(this.name, linkedPATemplate.name) && - Objects.equals(this.parentComponentId, linkedPATemplate.parentComponentId); - } - - @Override - public int hashCode() { - return Objects.hash(directory, snapshot, content, id, description, name, parentComponentId); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplate {\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java deleted file mode 100644 index 5662367c..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateParameters - */ -@JsonPropertyOrder({ - LinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, - LinkedPATemplateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, - LinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, - LinkedPATemplateParameters.JSON_PROPERTY_CONTENT -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; - private String parentComponentId; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - - public LinkedPATemplateParameters directory(String directory) { - this.directory = directory; - return this; - } - - /** - * The directory to create a linked PA template - * @return directory - **/ - @ApiModelProperty(required = true, value = "The directory to create a linked PA template") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public LinkedPATemplateParameters parentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - return this; - } - - /** - * Parent component id - * @return parentComponentId - **/ - @ApiModelProperty(required = true, value = "Parent component id") - @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getParentComponentId() { - return parentComponentId; - } - - - public void setParentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - } - - - public LinkedPATemplateParameters description(String description) { - this.description = description; - return this; - } - - /** - * Template description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public LinkedPATemplateParameters content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - /** - * Return true if this LinkedPATemplateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateParameters linkedPATemplateParameters = (LinkedPATemplateParameters) o; - return Objects.equals(this.directory, linkedPATemplateParameters.directory) && - Objects.equals(this.parentComponentId, linkedPATemplateParameters.parentComponentId) && - Objects.equals(this.description, linkedPATemplateParameters.description) && - Objects.equals(this.content, linkedPATemplateParameters.content); - } - - @Override - public int hashCode() { - return Objects.hash(directory, parentComponentId, description, content); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateParameters {\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java deleted file mode 100644 index 6be71c7f..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.LinkedPATemplateParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateParametersRoot - */ -@JsonPropertyOrder({ - LinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, - LinkedPATemplateParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private LinkedPATemplateParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public LinkedPATemplateParametersRoot data(LinkedPATemplateParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public LinkedPATemplateParameters getData() { - return data; - } - - - public void setData(LinkedPATemplateParameters data) { - this.data = data; - } - - - public LinkedPATemplateParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this LinkedPATemplateParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = (LinkedPATemplateParametersRoot) o; - return Objects.equals(this.data, linkedPATemplateParametersRoot.data) && - Objects.equals(this.meta, linkedPATemplateParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java deleted file mode 100644 index 8312997c..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java +++ /dev/null @@ -1,201 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplatePostSummary - */ -@JsonPropertyOrder({ - LinkedPATemplatePostSummary.JSON_PROPERTY_ID, - LinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, - LinkedPATemplatePostSummary.JSON_PROPERTY_NAME, - LinkedPATemplatePostSummary.JSON_PROPERTY_PARENT_COMPONENT_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplatePostSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; - private String parentComponentId; - - - public LinkedPATemplatePostSummary id(String id) { - this.id = id; - return this; - } - - /** - * Template id. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template id.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public LinkedPATemplatePostSummary description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public LinkedPATemplatePostSummary name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public LinkedPATemplatePostSummary parentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - return this; - } - - /** - * Template parent tile. - * @return parentComponentId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template parent tile.") - @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentComponentId() { - return parentComponentId; - } - - - public void setParentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - } - - - /** - * Return true if this LinkedPATemplatePostSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplatePostSummary linkedPATemplatePostSummary = (LinkedPATemplatePostSummary) o; - return Objects.equals(this.id, linkedPATemplatePostSummary.id) && - Objects.equals(this.description, linkedPATemplatePostSummary.description) && - Objects.equals(this.name, linkedPATemplatePostSummary.name) && - Objects.equals(this.parentComponentId, linkedPATemplatePostSummary.parentComponentId); - } - - @Override - public int hashCode() { - return Objects.hash(id, description, name, parentComponentId); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplatePostSummary {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java deleted file mode 100644 index 67290f3c..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.LinkedPATemplatePostSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplatePostSummaryRoot - */ -@JsonPropertyOrder({ - LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, - LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplatePostSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private LinkedPATemplatePostSummary data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public LinkedPATemplatePostSummaryRoot data(LinkedPATemplatePostSummary data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public LinkedPATemplatePostSummary getData() { - return data; - } - - - public void setData(LinkedPATemplatePostSummary data) { - this.data = data; - } - - - public LinkedPATemplatePostSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this LinkedPATemplatePostSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplatePostSummaryRoot linkedPATemplatePostSummaryRoot = (LinkedPATemplatePostSummaryRoot) o; - return Objects.equals(this.data, linkedPATemplatePostSummaryRoot.data) && - Objects.equals(this.meta, linkedPATemplatePostSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplatePostSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java deleted file mode 100644 index 18843692..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.LinkedPATemplate; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateRoot - */ -@JsonPropertyOrder({ - LinkedPATemplateRoot.JSON_PROPERTY_DATA, - LinkedPATemplateRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private LinkedPATemplate data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public LinkedPATemplateRoot data(LinkedPATemplate data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public LinkedPATemplate getData() { - return data; - } - - - public void setData(LinkedPATemplate data) { - this.data = data; - } - - - public LinkedPATemplateRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this LinkedPATemplateRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateRoot linkedPATemplateRoot = (LinkedPATemplateRoot) o; - return Objects.equals(this.data, linkedPATemplateRoot.data) && - Objects.equals(this.meta, linkedPATemplateRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java deleted file mode 100644 index 9f91aa69..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateSummary - */ -@JsonPropertyOrder({ - LinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, - LinkedPATemplateSummary.JSON_PROPERTY_NAME, - LinkedPATemplateSummary.JSON_PROPERTY_PARENT_COMPONENT_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; - private String parentComponentId; - - - public LinkedPATemplateSummary description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public LinkedPATemplateSummary name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public LinkedPATemplateSummary parentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - return this; - } - - /** - * Template parent tile. - * @return parentComponentId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template parent tile.") - @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentComponentId() { - return parentComponentId; - } - - - public void setParentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - } - - - /** - * Return true if this LinkedPATemplateSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateSummary linkedPATemplateSummary = (LinkedPATemplateSummary) o; - return Objects.equals(this.description, linkedPATemplateSummary.description) && - Objects.equals(this.name, linkedPATemplateSummary.name) && - Objects.equals(this.parentComponentId, linkedPATemplateSummary.parentComponentId); - } - - @Override - public int hashCode() { - return Objects.hash(description, name, parentComponentId); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateSummary {\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java deleted file mode 100644 index 60bd1858..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.LinkedPATemplateSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateSummaryRoot - */ -@JsonPropertyOrder({ - LinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, - LinkedPATemplateSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public LinkedPATemplateSummaryRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public LinkedPATemplateSummaryRoot putDataItem(String key, LinkedPATemplateSummary dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public LinkedPATemplateSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this LinkedPATemplateSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateSummaryRoot linkedPATemplateSummaryRoot = (LinkedPATemplateSummaryRoot) o; - return Objects.equals(this.data, linkedPATemplateSummaryRoot.data) && - Objects.equals(this.meta, linkedPATemplateSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java deleted file mode 100644 index 5ed2a4d0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java +++ /dev/null @@ -1,172 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateUpdateParameters - */ -@JsonPropertyOrder({ - LinkedPATemplateUpdateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, - LinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, - LinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateUpdateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; - private String parentComponentId; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - - public LinkedPATemplateUpdateParameters parentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - return this; - } - - /** - * Parent component id - * @return parentComponentId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Parent component id") - @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentComponentId() { - return parentComponentId; - } - - - public void setParentComponentId(String parentComponentId) { - this.parentComponentId = parentComponentId; - } - - - public LinkedPATemplateUpdateParameters description(String description) { - this.description = description; - return this; - } - - /** - * Template description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public LinkedPATemplateUpdateParameters content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - /** - * Return true if this LinkedPATemplateUpdateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateUpdateParameters linkedPATemplateUpdateParameters = (LinkedPATemplateUpdateParameters) o; - return Objects.equals(this.parentComponentId, linkedPATemplateUpdateParameters.parentComponentId) && - Objects.equals(this.description, linkedPATemplateUpdateParameters.description) && - Objects.equals(this.content, linkedPATemplateUpdateParameters.content); - } - - @Override - public int hashCode() { - return Objects.hash(parentComponentId, description, content); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateUpdateParameters {\n"); - sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java deleted file mode 100644 index 86e62d88..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * LinkedPATemplateUpdateParametersRoot - */ -@JsonPropertyOrder({ - LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, - LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class LinkedPATemplateUpdateParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private LinkedPATemplateUpdateParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public LinkedPATemplateUpdateParametersRoot data(LinkedPATemplateUpdateParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public LinkedPATemplateUpdateParameters getData() { - return data; - } - - - public void setData(LinkedPATemplateUpdateParameters data) { - this.data = data; - } - - - public LinkedPATemplateUpdateParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this LinkedPATemplateUpdateParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = (LinkedPATemplateUpdateParametersRoot) o; - return Objects.equals(this.data, linkedPATemplateUpdateParametersRoot.data) && - Objects.equals(this.meta, linkedPATemplateUpdateParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class LinkedPATemplateUpdateParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java deleted file mode 100644 index dca33ddf..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java +++ /dev/null @@ -1,149 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationColumn - */ -@JsonPropertyOrder({ - PACalculationColumn.JSON_PROPERTY_ID, - PACalculationColumn.JSON_PROPERTY_STATISTICS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationColumn implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_STATISTICS = "statistics"; - private java.util.List statistics = null; - - - public PACalculationColumn id(String id) { - this.id = id; - return this; - } - - /** - * FactSet-defined or User-defined Column identifier. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "FactSet-defined or User-defined Column identifier.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public PACalculationColumn statistics(java.util.List statistics) { - this.statistics = statistics; - return this; - } - - public PACalculationColumn addStatisticsItem(String statisticsItem) { - if (this.statistics == null) { - this.statistics = new java.util.ArrayList(); - } - this.statistics.add(statisticsItem); - return this; - } - - /** - * Column Statistic identifier - * @return statistics - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Statistic identifier") - @JsonProperty(JSON_PROPERTY_STATISTICS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getStatistics() { - return statistics; - } - - - public void setStatistics(java.util.List statistics) { - this.statistics = statistics; - } - - - /** - * Return true if this PACalculationColumn object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationColumn paCalculationColumn = (PACalculationColumn) o; - return Objects.equals(this.id, paCalculationColumn.id) && - Objects.equals(this.statistics, paCalculationColumn.statistics); - } - - @Override - public int hashCode() { - return Objects.hash(id, statistics); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationColumn {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" statistics: ").append(toIndentedString(statistics)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java deleted file mode 100644 index 08a7f10e..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java +++ /dev/null @@ -1,188 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationPricingSource; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationDataSources - */ -@JsonPropertyOrder({ - PACalculationDataSources.JSON_PROPERTY_PORTFOLIOPRICINGSOURCES, - PACalculationDataSources.JSON_PROPERTY_BENCHMARKPRICINGSOURCES, - PACalculationDataSources.JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationDataSources implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_PORTFOLIOPRICINGSOURCES = "portfoliopricingsources"; - private java.util.List portfoliopricingsources = null; - - public static final String JSON_PROPERTY_BENCHMARKPRICINGSOURCES = "benchmarkpricingsources"; - private java.util.List benchmarkpricingsources = null; - - public static final String JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK = "useportfoliopricingsourcesforbenchmark"; - private Boolean useportfoliopricingsourcesforbenchmark; - - - public PACalculationDataSources portfoliopricingsources(java.util.List portfoliopricingsources) { - this.portfoliopricingsources = portfoliopricingsources; - return this; - } - - public PACalculationDataSources addPortfoliopricingsourcesItem(PACalculationPricingSource portfoliopricingsourcesItem) { - if (this.portfoliopricingsources == null) { - this.portfoliopricingsources = new java.util.ArrayList(); - } - this.portfoliopricingsources.add(portfoliopricingsourcesItem); - return this; - } - - /** - * List of portfilio pricing source for the PA calculation - * @return portfoliopricingsources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of portfilio pricing source for the PA calculation") - @JsonProperty(JSON_PROPERTY_PORTFOLIOPRICINGSOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getPortfoliopricingsources() { - return portfoliopricingsources; - } - - - public void setPortfoliopricingsources(java.util.List portfoliopricingsources) { - this.portfoliopricingsources = portfoliopricingsources; - } - - - public PACalculationDataSources benchmarkpricingsources(java.util.List benchmarkpricingsources) { - this.benchmarkpricingsources = benchmarkpricingsources; - return this; - } - - public PACalculationDataSources addBenchmarkpricingsourcesItem(PACalculationPricingSource benchmarkpricingsourcesItem) { - if (this.benchmarkpricingsources == null) { - this.benchmarkpricingsources = new java.util.ArrayList(); - } - this.benchmarkpricingsources.add(benchmarkpricingsourcesItem); - return this; - } - - /** - * List of benchmark pricing source for the PA calculation - * @return benchmarkpricingsources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmark pricing source for the PA calculation") - @JsonProperty(JSON_PROPERTY_BENCHMARKPRICINGSOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarkpricingsources() { - return benchmarkpricingsources; - } - - - public void setBenchmarkpricingsources(java.util.List benchmarkpricingsources) { - this.benchmarkpricingsources = benchmarkpricingsources; - } - - - public PACalculationDataSources useportfoliopricingsourcesforbenchmark(Boolean useportfoliopricingsourcesforbenchmark) { - this.useportfoliopricingsourcesforbenchmark = useportfoliopricingsourcesforbenchmark; - return this; - } - - /** - * Use portfolio pricing sources for benchmark - * @return useportfoliopricingsourcesforbenchmark - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Use portfolio pricing sources for benchmark") - @JsonProperty(JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getUseportfoliopricingsourcesforbenchmark() { - return useportfoliopricingsourcesforbenchmark; - } - - - public void setUseportfoliopricingsourcesforbenchmark(Boolean useportfoliopricingsourcesforbenchmark) { - this.useportfoliopricingsourcesforbenchmark = useportfoliopricingsourcesforbenchmark; - } - - - /** - * Return true if this PACalculationDataSources object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationDataSources paCalculationDataSources = (PACalculationDataSources) o; - return Objects.equals(this.portfoliopricingsources, paCalculationDataSources.portfoliopricingsources) && - Objects.equals(this.benchmarkpricingsources, paCalculationDataSources.benchmarkpricingsources) && - Objects.equals(this.useportfoliopricingsourcesforbenchmark, paCalculationDataSources.useportfoliopricingsourcesforbenchmark); - } - - @Override - public int hashCode() { - return Objects.hash(portfoliopricingsources, benchmarkpricingsources, useportfoliopricingsourcesforbenchmark); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationDataSources {\n"); - sb.append(" portfoliopricingsources: ").append(toIndentedString(portfoliopricingsources)).append("\n"); - sb.append(" benchmarkpricingsources: ").append(toIndentedString(benchmarkpricingsources)).append("\n"); - sb.append(" useportfoliopricingsourcesforbenchmark: ").append(toIndentedString(useportfoliopricingsourcesforbenchmark)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java deleted file mode 100644 index fec5902a..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationGroup - */ -@JsonPropertyOrder({ - PACalculationGroup.JSON_PROPERTY_ID, - PACalculationGroup.JSON_PROPERTY_FREQUENCY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationGroup implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - - public PACalculationGroup id(String id) { - this.id = id; - return this; - } - - /** - * FactSet-defined or User-defined Group identifier. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "FactSet-defined or User-defined Group identifier.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public PACalculationGroup frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Grouping frequency - * @return frequency - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Grouping frequency") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - /** - * Return true if this PACalculationGroup object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationGroup paCalculationGroup = (PACalculationGroup) o; - return Objects.equals(this.id, paCalculationGroup.id) && - Objects.equals(this.frequency, paCalculationGroup.frequency); - } - - @Override - public int hashCode() { - return Objects.hash(id, frequency); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationGroup {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java deleted file mode 100644 index 73ff4f33..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java +++ /dev/null @@ -1,387 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationColumn; -import factset.analyticsapi.engines.models.PACalculationDataSources; -import factset.analyticsapi.engines.models.PACalculationGroup; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationParameters - */ -@JsonPropertyOrder({ - PACalculationParameters.JSON_PROPERTY_COMPONENTID, - PACalculationParameters.JSON_PROPERTY_ACCOUNTS, - PACalculationParameters.JSON_PROPERTY_BENCHMARKS, - PACalculationParameters.JSON_PROPERTY_DATES, - PACalculationParameters.JSON_PROPERTY_GROUPS, - PACalculationParameters.JSON_PROPERTY_CURRENCYISOCODE, - PACalculationParameters.JSON_PROPERTY_COLUMNS, - PACalculationParameters.JSON_PROPERTY_DATASOURCES, - PACalculationParameters.JSON_PROPERTY_COMPONENTDETAIL -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_COMPONENTID = "componentid"; - private String componentid; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_DATASOURCES = "datasources"; - private PACalculationDataSources datasources; - - public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; - private String componentdetail; - - - public PACalculationParameters componentid(String componentid) { - this.componentid = componentid; - return this; - } - - /** - * The PA Engine component identifier to analyze. - * @return componentid - **/ - @ApiModelProperty(required = true, value = "The PA Engine component identifier to analyze.") - @JsonProperty(JSON_PROPERTY_COMPONENTID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getComponentid() { - return componentid; - } - - - public void setComponentid(String componentid) { - this.componentid = componentid; - } - - - public PACalculationParameters accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public PACalculationParameters addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts. - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts.") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public PACalculationParameters benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public PACalculationParameters addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks. - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks.") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public PACalculationParameters dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public PACalculationParameters groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public PACalculationParameters addGroupsItem(PACalculationGroup groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public PACalculationParameters currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Currency ISO code for calculation. - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Currency ISO code for calculation.") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public PACalculationParameters columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public PACalculationParameters addColumnsItem(PACalculationColumn columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public PACalculationParameters datasources(PACalculationDataSources datasources) { - this.datasources = datasources; - return this; - } - - /** - * Get datasources - * @return datasources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATASOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACalculationDataSources getDatasources() { - return datasources; - } - - - public void setDatasources(PACalculationDataSources datasources) { - this.datasources = datasources; - } - - - public PACalculationParameters componentdetail(String componentdetail) { - this.componentdetail = componentdetail; - return this; - } - - /** - * Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. - * @return componentdetail - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") - @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getComponentdetail() { - return componentdetail; - } - - - public void setComponentdetail(String componentdetail) { - this.componentdetail = componentdetail; - } - - - /** - * Return true if this PACalculationParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationParameters paCalculationParameters = (PACalculationParameters) o; - return Objects.equals(this.componentid, paCalculationParameters.componentid) && - Objects.equals(this.accounts, paCalculationParameters.accounts) && - Objects.equals(this.benchmarks, paCalculationParameters.benchmarks) && - Objects.equals(this.dates, paCalculationParameters.dates) && - Objects.equals(this.groups, paCalculationParameters.groups) && - Objects.equals(this.currencyisocode, paCalculationParameters.currencyisocode) && - Objects.equals(this.columns, paCalculationParameters.columns) && - Objects.equals(this.datasources, paCalculationParameters.datasources) && - Objects.equals(this.componentdetail, paCalculationParameters.componentdetail); - } - - @Override - public int hashCode() { - return Objects.hash(componentid, accounts, benchmarks, dates, groups, currencyisocode, columns, datasources, componentdetail); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationParameters {\n"); - sb.append(" componentid: ").append(toIndentedString(componentid)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); - sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java deleted file mode 100644 index 1849ad0f..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java +++ /dev/null @@ -1,151 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.CalculationMeta; -import factset.analyticsapi.engines.models.PACalculationParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationParametersRoot - */ -@JsonPropertyOrder({ - PACalculationParametersRoot.JSON_PROPERTY_DATA, - PACalculationParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = null; - - public static final String JSON_PROPERTY_META = "meta"; - private CalculationMeta meta; - - - public PACalculationParametersRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public PACalculationParametersRoot putDataItem(String key, PACalculationParameters dataItem) { - if (this.data == null) { - this.data = new java.util.HashMap(); - } - this.data.put(key, dataItem); - return this; - } - - /** - * List of calculation parameters. - * @return data - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of calculation parameters.") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public PACalculationParametersRoot meta(CalculationMeta meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CalculationMeta getMeta() { - return meta; - } - - - public void setMeta(CalculationMeta meta) { - this.meta = meta; - } - - - /** - * Return true if this PACalculationParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationParametersRoot paCalculationParametersRoot = (PACalculationParametersRoot) o; - return Objects.equals(this.data, paCalculationParametersRoot.data) && - Objects.equals(this.meta, paCalculationParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java deleted file mode 100644 index 298f9dd7..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACalculationPricingSource - */ -@JsonPropertyOrder({ - PACalculationPricingSource.JSON_PROPERTY_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACalculationPricingSource implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - - public PACalculationPricingSource id(String id) { - this.id = id; - return this; - } - - /** - * Pricing source identifier - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Pricing source identifier") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - /** - * Return true if this PACalculationPricingSource object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACalculationPricingSource paCalculationPricingSource = (PACalculationPricingSource) o; - return Objects.equals(this.id, paCalculationPricingSource.id); - } - - @Override - public int hashCode() { - return Objects.hash(id); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACalculationPricingSource {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java deleted file mode 100644 index 5598661f..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java +++ /dev/null @@ -1,369 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAComponent - */ -@JsonPropertyOrder({ - PAComponent.JSON_PROPERTY_ID, - PAComponent.JSON_PROPERTY_ACCOUNTS, - PAComponent.JSON_PROPERTY_BENCHMARKS, - PAComponent.JSON_PROPERTY_CURRENCYISOCODE, - PAComponent.JSON_PROPERTY_DATES, - PAComponent.JSON_PROPERTY_SNAPSHOT, - PAComponent.JSON_PROPERTY_PATH, - PAComponent.JSON_PROPERTY_NAME, - PAComponent.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAComponent implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; - private Boolean snapshot; - - public static final String JSON_PROPERTY_PATH = "path"; - private String path; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public PAComponent id(String id) { - this.id = id; - return this; - } - - /** - * Component identifier. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component identifier.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public PAComponent accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public PAComponent addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts saved in the PA document. - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts saved in the PA document.") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public PAComponent benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public PAComponent addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks saved in the PA document. - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks saved in the PA document.") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public PAComponent currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Get currencyisocode - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public PAComponent dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public PAComponent snapshot(Boolean snapshot) { - this.snapshot = snapshot; - return this; - } - - /** - * Is the component type snapshot or subperiod. - * @return snapshot - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Is the component type snapshot or subperiod.") - @JsonProperty(JSON_PROPERTY_SNAPSHOT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSnapshot() { - return snapshot; - } - - - public void setSnapshot(Boolean snapshot) { - this.snapshot = snapshot; - } - - - public PAComponent path(String path) { - this.path = path; - return this; - } - - /** - * The path to the document - * @return path - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The path to the document") - @JsonProperty(JSON_PROPERTY_PATH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPath() { - return path; - } - - - public void setPath(String path) { - this.path = path; - } - - - public PAComponent name(String name) { - this.name = name; - return this; - } - - /** - * Component name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public PAComponent category(String category) { - this.category = category; - return this; - } - - /** - * Component category. - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component category.") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this PAComponent object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAComponent paComponent = (PAComponent) o; - return Objects.equals(this.id, paComponent.id) && - Objects.equals(this.accounts, paComponent.accounts) && - Objects.equals(this.benchmarks, paComponent.benchmarks) && - Objects.equals(this.currencyisocode, paComponent.currencyisocode) && - Objects.equals(this.dates, paComponent.dates) && - Objects.equals(this.snapshot, paComponent.snapshot) && - Objects.equals(this.path, paComponent.path) && - Objects.equals(this.name, paComponent.name) && - Objects.equals(this.category, paComponent.category); - } - - @Override - public int hashCode() { - return Objects.hash(id, accounts, benchmarks, currencyisocode, dates, snapshot, path, name, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAComponent {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); - sb.append(" path: ").append(toIndentedString(path)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java deleted file mode 100644 index 4ef3d796..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java +++ /dev/null @@ -1,358 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationColumn; -import factset.analyticsapi.engines.models.PACalculationDataSources; -import factset.analyticsapi.engines.models.PACalculationGroup; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAComponentData - */ -@JsonPropertyOrder({ - PAComponentData.JSON_PROPERTY_ACCOUNTS, - PAComponentData.JSON_PROPERTY_BENCHMARKS, - PAComponentData.JSON_PROPERTY_GROUPS, - PAComponentData.JSON_PROPERTY_COLUMNS, - PAComponentData.JSON_PROPERTY_DATES, - PAComponentData.JSON_PROPERTY_DATASOURCES, - PAComponentData.JSON_PROPERTY_CURRENCYISOCODE, - PAComponentData.JSON_PROPERTY_COMPONENTDETAIL -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAComponentData implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_DATASOURCES = "datasources"; - private PACalculationDataSources datasources; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; - private String componentdetail; - - - public PAComponentData accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public PAComponentData addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts. - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts.") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public PAComponentData benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public PAComponentData addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks. - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks.") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public PAComponentData groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public PAComponentData addGroupsItem(PACalculationGroup groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public PAComponentData columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public PAComponentData addColumnsItem(PACalculationColumn columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public PAComponentData dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public PAComponentData datasources(PACalculationDataSources datasources) { - this.datasources = datasources; - return this; - } - - /** - * Get datasources - * @return datasources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATASOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACalculationDataSources getDatasources() { - return datasources; - } - - - public void setDatasources(PACalculationDataSources datasources) { - this.datasources = datasources; - } - - - public PAComponentData currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Currency ISO code for calculation. - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Currency ISO code for calculation.") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public PAComponentData componentdetail(String componentdetail) { - this.componentdetail = componentdetail; - return this; - } - - /** - * PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. - * @return componentdetail - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") - @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getComponentdetail() { - return componentdetail; - } - - - public void setComponentdetail(String componentdetail) { - this.componentdetail = componentdetail; - } - - - /** - * Return true if this PAComponentData object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAComponentData paComponentData = (PAComponentData) o; - return Objects.equals(this.accounts, paComponentData.accounts) && - Objects.equals(this.benchmarks, paComponentData.benchmarks) && - Objects.equals(this.groups, paComponentData.groups) && - Objects.equals(this.columns, paComponentData.columns) && - Objects.equals(this.dates, paComponentData.dates) && - Objects.equals(this.datasources, paComponentData.datasources) && - Objects.equals(this.currencyisocode, paComponentData.currencyisocode) && - Objects.equals(this.componentdetail, paComponentData.componentdetail); - } - - @Override - public int hashCode() { - return Objects.hash(accounts, benchmarks, groups, columns, dates, datasources, currencyisocode, componentdetail); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAComponentData {\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java deleted file mode 100644 index 558256c6..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PAComponent; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAComponentRoot - */ -@JsonPropertyOrder({ - PAComponentRoot.JSON_PROPERTY_DATA, - PAComponentRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAComponentRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private PAComponent data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PAComponentRoot data(PAComponent data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PAComponent getData() { - return data; - } - - - public void setData(PAComponent data) { - this.data = data; - } - - - public PAComponentRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PAComponentRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAComponentRoot paComponentRoot = (PAComponentRoot) o; - return Objects.equals(this.data, paComponentRoot.data) && - Objects.equals(this.meta, paComponentRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAComponentRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java deleted file mode 100644 index d9f70d81..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java +++ /dev/null @@ -1,170 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * The date parameters for PA calculation. - */ -@ApiModel(description = "The date parameters for PA calculation.") -@JsonPropertyOrder({ - PADateParameters.JSON_PROPERTY_STARTDATE, - PADateParameters.JSON_PROPERTY_ENDDATE, - PADateParameters.JSON_PROPERTY_FREQUENCY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PADateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_STARTDATE = "startdate"; - private String startdate; - - public static final String JSON_PROPERTY_ENDDATE = "enddate"; - private String enddate; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - - public PADateParameters startdate(String startdate) { - this.startdate = startdate; - return this; - } - - /** - * Calculation's start date. - * @return startdate - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Calculation's start date.") - @JsonProperty(JSON_PROPERTY_STARTDATE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getStartdate() { - return startdate; - } - - - public void setStartdate(String startdate) { - this.startdate = startdate; - } - - - public PADateParameters enddate(String enddate) { - this.enddate = enddate; - return this; - } - - /** - * Calculation's end date. - * @return enddate - **/ - @ApiModelProperty(required = true, value = "Calculation's end date.") - @JsonProperty(JSON_PROPERTY_ENDDATE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getEnddate() { - return enddate; - } - - - public void setEnddate(String enddate) { - this.enddate = enddate; - } - - - public PADateParameters frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Calculation's frequency. - * @return frequency - **/ - @ApiModelProperty(required = true, value = "Calculation's frequency.") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - /** - * Return true if this PADateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PADateParameters paDateParameters = (PADateParameters) o; - return Objects.equals(this.startdate, paDateParameters.startdate) && - Objects.equals(this.enddate, paDateParameters.enddate) && - Objects.equals(this.frequency, paDateParameters.frequency); - } - - @Override - public int hashCode() { - return Objects.hash(startdate, enddate, frequency); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PADateParameters {\n"); - sb.append(" startdate: ").append(toIndentedString(startdate)).append("\n"); - sb.append(" enddate: ").append(toIndentedString(enddate)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java deleted file mode 100644 index c9c910b0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java +++ /dev/null @@ -1,140 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAIdentifier - */ -@JsonPropertyOrder({ - PAIdentifier.JSON_PROPERTY_ID, - PAIdentifier.JSON_PROPERTY_HOLDINGSMODE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAIdentifier implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_HOLDINGSMODE = "holdingsmode"; - private String holdingsmode; - - - public PAIdentifier id(String id) { - this.id = id; - return this; - } - - /** - * User's FactSet account path OR benchmark. - * @return id - **/ - @ApiModelProperty(required = true, value = "User's FactSet account path OR benchmark.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public PAIdentifier holdingsmode(String holdingsmode) { - this.holdingsmode = holdingsmode; - return this; - } - - /** - * Holdings Mode can be B&H, TBR, OMS , EXT or VLT. - * @return holdingsmode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Holdings Mode can be B&H, TBR, OMS , EXT or VLT.") - @JsonProperty(JSON_PROPERTY_HOLDINGSMODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getHoldingsmode() { - return holdingsmode; - } - - - public void setHoldingsmode(String holdingsmode) { - this.holdingsmode = holdingsmode; - } - - - /** - * Return true if this PAIdentifier object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAIdentifier paIdentifier = (PAIdentifier) o; - return Objects.equals(this.id, paIdentifier.id) && - Objects.equals(this.holdingsmode, paIdentifier.holdingsmode); - } - - @Override - public int hashCode() { - return Objects.hash(id, holdingsmode); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAIdentifier {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" holdingsmode: ").append(toIndentedString(holdingsmode)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java deleted file mode 100644 index 6dca9031..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAPricingSource - */ -@JsonPropertyOrder({ - PAPricingSource.JSON_PROPERTY_NAME, - PAPricingSource.JSON_PROPERTY_DIRECTORY, - PAPricingSource.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAPricingSource implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public PAPricingSource name(String name) { - this.name = name; - return this; - } - - /** - * Pricing source Name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Pricing source Name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public PAPricingSource directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Pricing source directory - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Pricing source directory") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public PAPricingSource category(String category) { - this.category = category; - return this; - } - - /** - * Pricing source category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Pricing source category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this PAPricingSource object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAPricingSource paPricingSource = (PAPricingSource) o; - return Objects.equals(this.name, paPricingSource.name) && - Objects.equals(this.directory, paPricingSource.directory) && - Objects.equals(this.category, paPricingSource.category); - } - - @Override - public int hashCode() { - return Objects.hash(name, directory, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAPricingSource {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java deleted file mode 100644 index 098ec800..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PAPricingSource; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PAPricingSourceRoot - */ -@JsonPropertyOrder({ - PAPricingSourceRoot.JSON_PROPERTY_DATA, - PAPricingSourceRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PAPricingSourceRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PAPricingSourceRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public PAPricingSourceRoot putDataItem(String key, PAPricingSource dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public PAPricingSourceRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PAPricingSourceRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PAPricingSourceRoot paPricingSourceRoot = (PAPricingSourceRoot) o; - return Objects.equals(this.data, paPricingSourceRoot.data) && - Objects.equals(this.meta, paPricingSourceRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PAPricingSourceRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java deleted file mode 100644 index 84d59278..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java +++ /dev/null @@ -1,110 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PaDoc - */ -@JsonPropertyOrder({ - PaDoc.JSON_PROPERTY_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PaDoc implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - - public PaDoc id(String id) { - this.id = id; - return this; - } - - /** - * PA document path - * @return id - **/ - @ApiModelProperty(required = true, value = "PA document path") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - /** - * Return true if this PaDoc object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PaDoc paDoc = (PaDoc) o; - return Objects.equals(this.id, paDoc.id); - } - - @Override - public int hashCode() { - return Objects.hash(id); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PaDoc {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java deleted file mode 100644 index a3e54271..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java +++ /dev/null @@ -1,207 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantDateListObsolete - */ -@JsonPropertyOrder({ - QuantDateListObsolete.JSON_PROPERTY_DATES, - QuantDateListObsolete.JSON_PROPERTY_FREQUENCY, - QuantDateListObsolete.JSON_PROPERTY_CALENDAR, - QuantDateListObsolete.JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantDateListObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATES = "dates"; - private java.util.List dates = null; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - public static final String JSON_PROPERTY_CALENDAR = "calendar"; - private String calendar; - - public static final String JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR = "overrideUniversalScreenCalendar"; - private Boolean overrideUniversalScreenCalendar; - - - public QuantDateListObsolete dates(java.util.List dates) { - this.dates = dates; - return this; - } - - public QuantDateListObsolete addDatesItem(String datesItem) { - if (this.dates == null) { - this.dates = new java.util.ArrayList(); - } - this.dates.add(datesItem); - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getDates() { - return dates; - } - - - public void setDates(java.util.List dates) { - this.dates = dates; - } - - - public QuantDateListObsolete frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Get frequency - * @return frequency - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - public QuantDateListObsolete calendar(String calendar) { - this.calendar = calendar; - return this; - } - - /** - * Get calendar - * @return calendar - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_CALENDAR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getCalendar() { - return calendar; - } - - - public void setCalendar(String calendar) { - this.calendar = calendar; - } - - - public QuantDateListObsolete overrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { - this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; - return this; - } - - /** - * Get overrideUniversalScreenCalendar - * @return overrideUniversalScreenCalendar - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getOverrideUniversalScreenCalendar() { - return overrideUniversalScreenCalendar; - } - - - public void setOverrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { - this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; - } - - - /** - * Return true if this QuantDateListObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantDateListObsolete quantDateListObsolete = (QuantDateListObsolete) o; - return Objects.equals(this.dates, quantDateListObsolete.dates) && - Objects.equals(this.frequency, quantDateListObsolete.frequency) && - Objects.equals(this.calendar, quantDateListObsolete.calendar) && - Objects.equals(this.overrideUniversalScreenCalendar, quantDateListObsolete.overrideUniversalScreenCalendar); - } - - @Override - public int hashCode() { - return Objects.hash(dates, frequency, calendar, overrideUniversalScreenCalendar); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantDateListObsolete {\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); - sb.append(" overrideUniversalScreenCalendar: ").append(toIndentedString(overrideUniversalScreenCalendar)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java deleted file mode 100644 index bc33f79b..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java +++ /dev/null @@ -1,227 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantFdsDateObsolete - */ -@JsonPropertyOrder({ - QuantFdsDateObsolete.JSON_PROPERTY_START_DATE, - QuantFdsDateObsolete.JSON_PROPERTY_END_DATE, - QuantFdsDateObsolete.JSON_PROPERTY_FREQUENCY, - QuantFdsDateObsolete.JSON_PROPERTY_CALENDAR, - QuantFdsDateObsolete.JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantFdsDateObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_START_DATE = "startDate"; - private String startDate; - - public static final String JSON_PROPERTY_END_DATE = "endDate"; - private String endDate; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - public static final String JSON_PROPERTY_CALENDAR = "calendar"; - private String calendar; - - public static final String JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR = "overrideUniversalScreenCalendar"; - private Boolean overrideUniversalScreenCalendar; - - - public QuantFdsDateObsolete startDate(String startDate) { - this.startDate = startDate; - return this; - } - - /** - * Get startDate - * @return startDate - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_START_DATE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getStartDate() { - return startDate; - } - - - public void setStartDate(String startDate) { - this.startDate = startDate; - } - - - public QuantFdsDateObsolete endDate(String endDate) { - this.endDate = endDate; - return this; - } - - /** - * Get endDate - * @return endDate - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_END_DATE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getEndDate() { - return endDate; - } - - - public void setEndDate(String endDate) { - this.endDate = endDate; - } - - - public QuantFdsDateObsolete frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Get frequency - * @return frequency - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - public QuantFdsDateObsolete calendar(String calendar) { - this.calendar = calendar; - return this; - } - - /** - * Get calendar - * @return calendar - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_CALENDAR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getCalendar() { - return calendar; - } - - - public void setCalendar(String calendar) { - this.calendar = calendar; - } - - - public QuantFdsDateObsolete overrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { - this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; - return this; - } - - /** - * Get overrideUniversalScreenCalendar - * @return overrideUniversalScreenCalendar - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getOverrideUniversalScreenCalendar() { - return overrideUniversalScreenCalendar; - } - - - public void setOverrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { - this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; - } - - - /** - * Return true if this QuantFdsDateObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantFdsDateObsolete quantFdsDateObsolete = (QuantFdsDateObsolete) o; - return Objects.equals(this.startDate, quantFdsDateObsolete.startDate) && - Objects.equals(this.endDate, quantFdsDateObsolete.endDate) && - Objects.equals(this.frequency, quantFdsDateObsolete.frequency) && - Objects.equals(this.calendar, quantFdsDateObsolete.calendar) && - Objects.equals(this.overrideUniversalScreenCalendar, quantFdsDateObsolete.overrideUniversalScreenCalendar); - } - - @Override - public int hashCode() { - return Objects.hash(startDate, endDate, frequency, calendar, overrideUniversalScreenCalendar); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantFdsDateObsolete {\n"); - sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); - sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); - sb.append(" overrideUniversalScreenCalendar: ").append(toIndentedString(overrideUniversalScreenCalendar)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java deleted file mode 100644 index 78e8603a..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java +++ /dev/null @@ -1,199 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantFqlExpressionObsolete - */ -@JsonPropertyOrder({ - QuantFqlExpressionObsolete.JSON_PROPERTY_EXPR, - QuantFqlExpressionObsolete.JSON_PROPERTY_NAME, - QuantFqlExpressionObsolete.JSON_PROPERTY_DATE_OFFSET, - QuantFqlExpressionObsolete.JSON_PROPERTY_IS_ARRAY_RETURN_TYPE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantFqlExpressionObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_EXPR = "expr"; - private String expr; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DATE_OFFSET = "dateOffset"; - private String dateOffset; - - public static final String JSON_PROPERTY_IS_ARRAY_RETURN_TYPE = "isArrayReturnType"; - private Boolean isArrayReturnType; - - - public QuantFqlExpressionObsolete expr(String expr) { - this.expr = expr; - return this; - } - - /** - * Get expr - * @return expr - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_EXPR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getExpr() { - return expr; - } - - - public void setExpr(String expr) { - this.expr = expr; - } - - - public QuantFqlExpressionObsolete name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public QuantFqlExpressionObsolete dateOffset(String dateOffset) { - this.dateOffset = dateOffset; - return this; - } - - /** - * Get dateOffset - * @return dateOffset - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATE_OFFSET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDateOffset() { - return dateOffset; - } - - - public void setDateOffset(String dateOffset) { - this.dateOffset = dateOffset; - } - - - public QuantFqlExpressionObsolete isArrayReturnType(Boolean isArrayReturnType) { - this.isArrayReturnType = isArrayReturnType; - return this; - } - - /** - * Get isArrayReturnType - * @return isArrayReturnType - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_IS_ARRAY_RETURN_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIsArrayReturnType() { - return isArrayReturnType; - } - - - public void setIsArrayReturnType(Boolean isArrayReturnType) { - this.isArrayReturnType = isArrayReturnType; - } - - - /** - * Return true if this QuantFqlExpressionObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantFqlExpressionObsolete quantFqlExpressionObsolete = (QuantFqlExpressionObsolete) o; - return Objects.equals(this.expr, quantFqlExpressionObsolete.expr) && - Objects.equals(this.name, quantFqlExpressionObsolete.name) && - Objects.equals(this.dateOffset, quantFqlExpressionObsolete.dateOffset) && - Objects.equals(this.isArrayReturnType, quantFqlExpressionObsolete.isArrayReturnType); - } - - @Override - public int hashCode() { - return Objects.hash(expr, name, dateOffset, isArrayReturnType); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantFqlExpressionObsolete {\n"); - sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" dateOffset: ").append(toIndentedString(dateOffset)).append("\n"); - sb.append(" isArrayReturnType: ").append(toIndentedString(isArrayReturnType)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java deleted file mode 100644 index dec5f67b..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java +++ /dev/null @@ -1,246 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantIdentifierUniverseObsolete - */ -@JsonPropertyOrder({ - QuantIdentifierUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, - QuantIdentifierUniverseObsolete.JSON_PROPERTY_IDENTIFIERS, - QuantIdentifierUniverseObsolete.JSON_PROPERTY_SOURCE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantIdentifierUniverseObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - /** - * Gets or Sets universeType - */ - public enum UniverseTypeEnum { - EQUITY("Equity"), - - DEBT("Debt"); - - private String value; - - UniverseTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static UniverseTypeEnum fromValue(String value) { - for (UniverseTypeEnum b : UniverseTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; - private UniverseTypeEnum universeType; - - public static final String JSON_PROPERTY_IDENTIFIERS = "identifiers"; - private java.util.List identifiers = new java.util.ArrayList(); - - /** - * Gets or Sets source - */ - public enum SourceEnum { - SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), - - UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), - - IDENTIFIERUNIVERSE("IdentifierUniverse"); - - private String value; - - SourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SourceEnum fromValue(String value) { - for (SourceEnum b : SourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SOURCE = "source"; - private SourceEnum source; - - - public QuantIdentifierUniverseObsolete universeType(UniverseTypeEnum universeType) { - this.universeType = universeType; - return this; - } - - /** - * Get universeType - * @return universeType - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UniverseTypeEnum getUniverseType() { - return universeType; - } - - - public void setUniverseType(UniverseTypeEnum universeType) { - this.universeType = universeType; - } - - - public QuantIdentifierUniverseObsolete identifiers(java.util.List identifiers) { - this.identifiers = identifiers; - return this; - } - - public QuantIdentifierUniverseObsolete addIdentifiersItem(String identifiersItem) { - this.identifiers.add(identifiersItem); - return this; - } - - /** - * Get identifiers - * @return identifiers - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_IDENTIFIERS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.List getIdentifiers() { - return identifiers; - } - - - public void setIdentifiers(java.util.List identifiers) { - this.identifiers = identifiers; - } - - - public QuantIdentifierUniverseObsolete source(SourceEnum source) { - this.source = source; - return this; - } - - /** - * Get source - * @return source - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SourceEnum getSource() { - return source; - } - - - public void setSource(SourceEnum source) { - this.source = source; - } - - - /** - * Return true if this QuantIdentifierUniverseObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantIdentifierUniverseObsolete quantIdentifierUniverseObsolete = (QuantIdentifierUniverseObsolete) o; - return Objects.equals(this.universeType, quantIdentifierUniverseObsolete.universeType) && - Objects.equals(this.identifiers, quantIdentifierUniverseObsolete.identifiers) && - Objects.equals(this.source, quantIdentifierUniverseObsolete.source); - } - - @Override - public int hashCode() { - return Objects.hash(universeType, identifiers, source); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantIdentifierUniverseObsolete {\n"); - sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); - sb.append(" identifiers: ").append(toIndentedString(identifiers)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java deleted file mode 100644 index d56aa331..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java +++ /dev/null @@ -1,169 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantScreeningExpressionObsolete - */ -@JsonPropertyOrder({ - QuantScreeningExpressionObsolete.JSON_PROPERTY_EXPR, - QuantScreeningExpressionObsolete.JSON_PROPERTY_NAME, - QuantScreeningExpressionObsolete.JSON_PROPERTY_DATE_OFFSET -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantScreeningExpressionObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_EXPR = "expr"; - private String expr; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_DATE_OFFSET = "dateOffset"; - private String dateOffset; - - - public QuantScreeningExpressionObsolete expr(String expr) { - this.expr = expr; - return this; - } - - /** - * Get expr - * @return expr - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_EXPR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getExpr() { - return expr; - } - - - public void setExpr(String expr) { - this.expr = expr; - } - - - public QuantScreeningExpressionObsolete name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public QuantScreeningExpressionObsolete dateOffset(String dateOffset) { - this.dateOffset = dateOffset; - return this; - } - - /** - * Get dateOffset - * @return dateOffset - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATE_OFFSET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDateOffset() { - return dateOffset; - } - - - public void setDateOffset(String dateOffset) { - this.dateOffset = dateOffset; - } - - - /** - * Return true if this QuantScreeningExpressionObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantScreeningExpressionObsolete quantScreeningExpressionObsolete = (QuantScreeningExpressionObsolete) o; - return Objects.equals(this.expr, quantScreeningExpressionObsolete.expr) && - Objects.equals(this.name, quantScreeningExpressionObsolete.name) && - Objects.equals(this.dateOffset, quantScreeningExpressionObsolete.dateOffset); - } - - @Override - public int hashCode() { - return Objects.hash(expr, name, dateOffset); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantScreeningExpressionObsolete {\n"); - sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" dateOffset: ").append(toIndentedString(dateOffset)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java deleted file mode 100644 index e55c3861..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java +++ /dev/null @@ -1,271 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantScreeningExpressionUniverseObsolete - */ -@JsonPropertyOrder({ - QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_EXPR, - QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, - QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SECURITY_EXPR, - QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SOURCE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantScreeningExpressionUniverseObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_UNIVERSE_EXPR = "universeExpr"; - private String universeExpr; - - /** - * Gets or Sets universeType - */ - public enum UniverseTypeEnum { - EQUITY("Equity"), - - DEBT("Debt"); - - private String value; - - UniverseTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static UniverseTypeEnum fromValue(String value) { - for (UniverseTypeEnum b : UniverseTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; - private UniverseTypeEnum universeType; - - public static final String JSON_PROPERTY_SECURITY_EXPR = "securityExpr"; - private String securityExpr; - - /** - * Gets or Sets source - */ - public enum SourceEnum { - SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), - - UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), - - IDENTIFIERUNIVERSE("IdentifierUniverse"); - - private String value; - - SourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SourceEnum fromValue(String value) { - for (SourceEnum b : SourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SOURCE = "source"; - private SourceEnum source; - - - public QuantScreeningExpressionUniverseObsolete universeExpr(String universeExpr) { - this.universeExpr = universeExpr; - return this; - } - - /** - * Get universeExpr - * @return universeExpr - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getUniverseExpr() { - return universeExpr; - } - - - public void setUniverseExpr(String universeExpr) { - this.universeExpr = universeExpr; - } - - - public QuantScreeningExpressionUniverseObsolete universeType(UniverseTypeEnum universeType) { - this.universeType = universeType; - return this; - } - - /** - * Get universeType - * @return universeType - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UniverseTypeEnum getUniverseType() { - return universeType; - } - - - public void setUniverseType(UniverseTypeEnum universeType) { - this.universeType = universeType; - } - - - public QuantScreeningExpressionUniverseObsolete securityExpr(String securityExpr) { - this.securityExpr = securityExpr; - return this; - } - - /** - * Get securityExpr - * @return securityExpr - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SECURITY_EXPR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSecurityExpr() { - return securityExpr; - } - - - public void setSecurityExpr(String securityExpr) { - this.securityExpr = securityExpr; - } - - - public QuantScreeningExpressionUniverseObsolete source(SourceEnum source) { - this.source = source; - return this; - } - - /** - * Get source - * @return source - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SourceEnum getSource() { - return source; - } - - - public void setSource(SourceEnum source) { - this.source = source; - } - - - /** - * Return true if this QuantScreeningExpressionUniverseObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantScreeningExpressionUniverseObsolete quantScreeningExpressionUniverseObsolete = (QuantScreeningExpressionUniverseObsolete) o; - return Objects.equals(this.universeExpr, quantScreeningExpressionUniverseObsolete.universeExpr) && - Objects.equals(this.universeType, quantScreeningExpressionUniverseObsolete.universeType) && - Objects.equals(this.securityExpr, quantScreeningExpressionUniverseObsolete.securityExpr) && - Objects.equals(this.source, quantScreeningExpressionUniverseObsolete.source); - } - - @Override - public int hashCode() { - return Objects.hash(universeExpr, universeType, securityExpr, source); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantScreeningExpressionUniverseObsolete {\n"); - sb.append(" universeExpr: ").append(toIndentedString(universeExpr)).append("\n"); - sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); - sb.append(" securityExpr: ").append(toIndentedString(securityExpr)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java deleted file mode 100644 index a899276d..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java +++ /dev/null @@ -1,139 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantUniversalScreenParameterObsolete - */ -@JsonPropertyOrder({ - QuantUniversalScreenParameterObsolete.JSON_PROPERTY_REFERENCE_NAME, - QuantUniversalScreenParameterObsolete.JSON_PROPERTY_NAME -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantUniversalScreenParameterObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_REFERENCE_NAME = "referenceName"; - private String referenceName; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - - public QuantUniversalScreenParameterObsolete referenceName(String referenceName) { - this.referenceName = referenceName; - return this; - } - - /** - * Get referenceName - * @return referenceName - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getReferenceName() { - return referenceName; - } - - - public void setReferenceName(String referenceName) { - this.referenceName = referenceName; - } - - - public QuantUniversalScreenParameterObsolete name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - /** - * Return true if this QuantUniversalScreenParameterObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantUniversalScreenParameterObsolete quantUniversalScreenParameterObsolete = (QuantUniversalScreenParameterObsolete) o; - return Objects.equals(this.referenceName, quantUniversalScreenParameterObsolete.referenceName) && - Objects.equals(this.name, quantUniversalScreenParameterObsolete.name); - } - - @Override - public int hashCode() { - return Objects.hash(referenceName, name); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantUniversalScreenParameterObsolete {\n"); - sb.append(" referenceName: ").append(toIndentedString(referenceName)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java deleted file mode 100644 index 1d9832b5..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java +++ /dev/null @@ -1,177 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * QuantUniversalScreenUniverseObsolete - */ -@JsonPropertyOrder({ - QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SCREEN, - QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SOURCE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class QuantUniversalScreenUniverseObsolete implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_SCREEN = "screen"; - private String screen; - - /** - * Gets or Sets source - */ - public enum SourceEnum { - SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), - - UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), - - IDENTIFIERUNIVERSE("IdentifierUniverse"); - - private String value; - - SourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SourceEnum fromValue(String value) { - for (SourceEnum b : SourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SOURCE = "source"; - private SourceEnum source; - - - public QuantUniversalScreenUniverseObsolete screen(String screen) { - this.screen = screen; - return this; - } - - /** - * Get screen - * @return screen - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_SCREEN) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getScreen() { - return screen; - } - - - public void setScreen(String screen) { - this.screen = screen; - } - - - public QuantUniversalScreenUniverseObsolete source(SourceEnum source) { - this.source = source; - return this; - } - - /** - * Get source - * @return source - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SourceEnum getSource() { - return source; - } - - - public void setSource(SourceEnum source) { - this.source = source; - } - - - /** - * Return true if this QuantUniversalScreenUniverseObsolete object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuantUniversalScreenUniverseObsolete quantUniversalScreenUniverseObsolete = (QuantUniversalScreenUniverseObsolete) o; - return Objects.equals(this.screen, quantUniversalScreenUniverseObsolete.screen) && - Objects.equals(this.source, quantUniversalScreenUniverseObsolete.source); - } - - @Override - public int hashCode() { - return Objects.hash(screen, source); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuantUniversalScreenUniverseObsolete {\n"); - sb.append(" screen: ").append(toIndentedString(screen)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java index 3745cbd7..149b7546 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java @@ -36,7 +36,8 @@ @JsonPropertyOrder({ SPARDateParameters.JSON_PROPERTY_STARTDATE, SPARDateParameters.JSON_PROPERTY_ENDDATE, - SPARDateParameters.JSON_PROPERTY_FREQUENCY + SPARDateParameters.JSON_PROPERTY_FREQUENCY, + SPARDateParameters.JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class SPARDateParameters implements Serializable { @@ -51,6 +52,9 @@ public class SPARDateParameters implements Serializable { public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; + public static final String JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION = "useeachportfolioinception"; + private Boolean useeachportfolioinception; + public SPARDateParameters startdate(String startdate) { this.startdate = startdate; @@ -121,6 +125,30 @@ public void setFrequency(String frequency) { } + public SPARDateParameters useeachportfolioinception(Boolean useeachportfolioinception) { + this.useeachportfolioinception = useeachportfolioinception; + return this; + } + + /** + * Use Each Portfolio Inception + * @return useeachportfolioinception + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Use Each Portfolio Inception") + @JsonProperty(JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseeachportfolioinception() { + return useeachportfolioinception; + } + + + public void setUseeachportfolioinception(Boolean useeachportfolioinception) { + this.useeachportfolioinception = useeachportfolioinception; + } + + /** * Return true if this SPARDateParameters object is equal to o. */ @@ -135,12 +163,13 @@ public boolean equals(Object o) { SPARDateParameters spARDateParameters = (SPARDateParameters) o; return Objects.equals(this.startdate, spARDateParameters.startdate) && Objects.equals(this.enddate, spARDateParameters.enddate) && - Objects.equals(this.frequency, spARDateParameters.frequency); + Objects.equals(this.frequency, spARDateParameters.frequency) && + Objects.equals(this.useeachportfolioinception, spARDateParameters.useeachportfolioinception); } @Override public int hashCode() { - return Objects.hash(startdate, enddate, frequency); + return Objects.hash(startdate, enddate, frequency, useeachportfolioinception); } @Override @@ -150,6 +179,7 @@ public String toString() { sb.append(" startdate: ").append(toIndentedString(startdate)).append("\n"); sb.append(" enddate: ").append(toIndentedString(enddate)).append("\n"); sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" useeachportfolioinception: ").append(toIndentedString(useeachportfolioinception)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java deleted file mode 100644 index 8265863e..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java +++ /dev/null @@ -1,195 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplateContentTypes - */ -@JsonPropertyOrder({ - TemplateContentTypes.JSON_PROPERTY_MANDATORY, - TemplateContentTypes.JSON_PROPERTY_OPTIONAL, - TemplateContentTypes.JSON_PROPERTY_LOCKED -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplateContentTypes implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_MANDATORY = "mandatory"; - private java.util.List mandatory = null; - - public static final String JSON_PROPERTY_OPTIONAL = "optional"; - private java.util.List optional = null; - - public static final String JSON_PROPERTY_LOCKED = "locked"; - private java.util.List locked = null; - - - public TemplateContentTypes mandatory(java.util.List mandatory) { - this.mandatory = mandatory; - return this; - } - - public TemplateContentTypes addMandatoryItem(String mandatoryItem) { - if (this.mandatory == null) { - this.mandatory = new java.util.ArrayList(); - } - this.mandatory.add(mandatoryItem); - return this; - } - - /** - * Template mandatory fields - * @return mandatory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template mandatory fields") - @JsonProperty(JSON_PROPERTY_MANDATORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getMandatory() { - return mandatory; - } - - - public void setMandatory(java.util.List mandatory) { - this.mandatory = mandatory; - } - - - public TemplateContentTypes optional(java.util.List optional) { - this.optional = optional; - return this; - } - - public TemplateContentTypes addOptionalItem(String optionalItem) { - if (this.optional == null) { - this.optional = new java.util.ArrayList(); - } - this.optional.add(optionalItem); - return this; - } - - /** - * Template optional fields - * @return optional - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template optional fields") - @JsonProperty(JSON_PROPERTY_OPTIONAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getOptional() { - return optional; - } - - - public void setOptional(java.util.List optional) { - this.optional = optional; - } - - - public TemplateContentTypes locked(java.util.List locked) { - this.locked = locked; - return this; - } - - public TemplateContentTypes addLockedItem(String lockedItem) { - if (this.locked == null) { - this.locked = new java.util.ArrayList(); - } - this.locked.add(lockedItem); - return this; - } - - /** - * Template locked fields - * @return locked - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template locked fields") - @JsonProperty(JSON_PROPERTY_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getLocked() { - return locked; - } - - - public void setLocked(java.util.List locked) { - this.locked = locked; - } - - - /** - * Return true if this TemplateContentTypes object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplateContentTypes templateContentTypes = (TemplateContentTypes) o; - return Objects.equals(this.mandatory, templateContentTypes.mandatory) && - Objects.equals(this.optional, templateContentTypes.optional) && - Objects.equals(this.locked, templateContentTypes.locked); - } - - @Override - public int hashCode() { - return Objects.hash(mandatory, optional, locked); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplateContentTypes {\n"); - sb.append(" mandatory: ").append(toIndentedString(mandatory)).append("\n"); - sb.append(" optional: ").append(toIndentedString(optional)).append("\n"); - sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java deleted file mode 100644 index 67b2dc3d..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java +++ /dev/null @@ -1,322 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PAComponentData; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponent - */ -@JsonPropertyOrder({ - TemplatedPAComponent.JSON_PROPERTY_ID, - TemplatedPAComponent.JSON_PROPERTY_DIRECTORY, - TemplatedPAComponent.JSON_PROPERTY_SNAPSHOT, - TemplatedPAComponent.JSON_PROPERTY_COMPONENT_DATA, - TemplatedPAComponent.JSON_PROPERTY_DESCRIPTION, - TemplatedPAComponent.JSON_PROPERTY_NAME, - TemplatedPAComponent.JSON_PROPERTY_PARENT_TEMPLATE_ID, - TemplatedPAComponent.JSON_PROPERTY_TYPE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponent implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; - private Boolean snapshot; - - public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; - private PAComponentData componentData; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; - private String parentTemplateId; - - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - - - public TemplatedPAComponent id(String id) { - this.id = id; - return this; - } - - /** - * Get id - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public TemplatedPAComponent directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Get directory - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public TemplatedPAComponent snapshot(Boolean snapshot) { - this.snapshot = snapshot; - return this; - } - - /** - * Get snapshot - * @return snapshot - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SNAPSHOT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSnapshot() { - return snapshot; - } - - - public void setSnapshot(Boolean snapshot) { - this.snapshot = snapshot; - } - - - public TemplatedPAComponent componentData(PAComponentData componentData) { - this.componentData = componentData; - return this; - } - - /** - * Get componentData - * @return componentData - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PAComponentData getComponentData() { - return componentData; - } - - - public void setComponentData(PAComponentData componentData) { - this.componentData = componentData; - } - - - public TemplatedPAComponent description(String description) { - this.description = description; - return this; - } - - /** - * Get description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public TemplatedPAComponent name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public TemplatedPAComponent parentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - return this; - } - - /** - * Get parentTemplateId - * @return parentTemplateId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentTemplateId() { - return parentTemplateId; - } - - - public void setParentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - } - - - public TemplatedPAComponent type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getType() { - return type; - } - - - public void setType(String type) { - this.type = type; - } - - - /** - * Return true if this TemplatedPAComponent object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponent templatedPAComponent = (TemplatedPAComponent) o; - return Objects.equals(this.id, templatedPAComponent.id) && - Objects.equals(this.directory, templatedPAComponent.directory) && - Objects.equals(this.snapshot, templatedPAComponent.snapshot) && - Objects.equals(this.componentData, templatedPAComponent.componentData) && - Objects.equals(this.description, templatedPAComponent.description) && - Objects.equals(this.name, templatedPAComponent.name) && - Objects.equals(this.parentTemplateId, templatedPAComponent.parentTemplateId) && - Objects.equals(this.type, templatedPAComponent.type); - } - - @Override - public int hashCode() { - return Objects.hash(id, directory, snapshot, componentData, description, name, parentTemplateId, type); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponent {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); - sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java deleted file mode 100644 index 4b3b8e34..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PAComponentData; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentParameters - */ -@JsonPropertyOrder({ - TemplatedPAComponentParameters.JSON_PROPERTY_DIRECTORY, - TemplatedPAComponentParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, - TemplatedPAComponentParameters.JSON_PROPERTY_DESCRIPTION, - TemplatedPAComponentParameters.JSON_PROPERTY_COMPONENT_DATA -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; - private String parentTemplateId; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; - private PAComponentData componentData; - - - public TemplatedPAComponentParameters directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Directory to create templated components - * @return directory - **/ - @ApiModelProperty(required = true, value = "Directory to create templated components") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public TemplatedPAComponentParameters parentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - return this; - } - - /** - * Parent template id - * @return parentTemplateId - **/ - @ApiModelProperty(required = true, value = "Parent template id") - @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getParentTemplateId() { - return parentTemplateId; - } - - - public void setParentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - } - - - public TemplatedPAComponentParameters description(String description) { - this.description = description; - return this; - } - - /** - * Component description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public TemplatedPAComponentParameters componentData(PAComponentData componentData) { - this.componentData = componentData; - return this; - } - - /** - * Get componentData - * @return componentData - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PAComponentData getComponentData() { - return componentData; - } - - - public void setComponentData(PAComponentData componentData) { - this.componentData = componentData; - } - - - /** - * Return true if this TemplatedPAComponentParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentParameters templatedPAComponentParameters = (TemplatedPAComponentParameters) o; - return Objects.equals(this.directory, templatedPAComponentParameters.directory) && - Objects.equals(this.parentTemplateId, templatedPAComponentParameters.parentTemplateId) && - Objects.equals(this.description, templatedPAComponentParameters.description) && - Objects.equals(this.componentData, templatedPAComponentParameters.componentData); - } - - @Override - public int hashCode() { - return Objects.hash(directory, parentTemplateId, description, componentData); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentParameters {\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java deleted file mode 100644 index 9e14bfdc..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java +++ /dev/null @@ -1,231 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentPostSummary - */ -@JsonPropertyOrder({ - TemplatedPAComponentPostSummary.JSON_PROPERTY_ID, - TemplatedPAComponentPostSummary.JSON_PROPERTY_DESCRIPTION, - TemplatedPAComponentPostSummary.JSON_PROPERTY_NAME, - TemplatedPAComponentPostSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, - TemplatedPAComponentPostSummary.JSON_PROPERTY_TYPE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentPostSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; - private String parentTemplateId; - - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - - - public TemplatedPAComponentPostSummary id(String id) { - this.id = id; - return this; - } - - /** - * Get id - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public TemplatedPAComponentPostSummary description(String description) { - this.description = description; - return this; - } - - /** - * Get description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public TemplatedPAComponentPostSummary name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public TemplatedPAComponentPostSummary parentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - return this; - } - - /** - * Get parentTemplateId - * @return parentTemplateId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentTemplateId() { - return parentTemplateId; - } - - - public void setParentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - } - - - public TemplatedPAComponentPostSummary type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getType() { - return type; - } - - - public void setType(String type) { - this.type = type; - } - - - /** - * Return true if this TemplatedPAComponentPostSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentPostSummary templatedPAComponentPostSummary = (TemplatedPAComponentPostSummary) o; - return Objects.equals(this.id, templatedPAComponentPostSummary.id) && - Objects.equals(this.description, templatedPAComponentPostSummary.description) && - Objects.equals(this.name, templatedPAComponentPostSummary.name) && - Objects.equals(this.parentTemplateId, templatedPAComponentPostSummary.parentTemplateId) && - Objects.equals(this.type, templatedPAComponentPostSummary.type); - } - - @Override - public int hashCode() { - return Objects.hash(id, description, name, parentTemplateId, type); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentPostSummary {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java deleted file mode 100644 index ebfed98a..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentPostSummaryRoot - */ -@JsonPropertyOrder({ - TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_DATA, - TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentPostSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private TemplatedPAComponentPostSummary data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public TemplatedPAComponentPostSummaryRoot data(TemplatedPAComponentPostSummary data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public TemplatedPAComponentPostSummary getData() { - return data; - } - - - public void setData(TemplatedPAComponentPostSummary data) { - this.data = data; - } - - - public TemplatedPAComponentPostSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this TemplatedPAComponentPostSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentPostSummaryRoot templatedPAComponentPostSummaryRoot = (TemplatedPAComponentPostSummaryRoot) o; - return Objects.equals(this.data, templatedPAComponentPostSummaryRoot.data) && - Objects.equals(this.meta, templatedPAComponentPostSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentPostSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java deleted file mode 100644 index 888730a3..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplatedPAComponent; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentRoot - */ -@JsonPropertyOrder({ - TemplatedPAComponentRoot.JSON_PROPERTY_DATA, - TemplatedPAComponentRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private TemplatedPAComponent data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public TemplatedPAComponentRoot data(TemplatedPAComponent data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public TemplatedPAComponent getData() { - return data; - } - - - public void setData(TemplatedPAComponent data) { - this.data = data; - } - - - public TemplatedPAComponentRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this TemplatedPAComponentRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentRoot templatedPAComponentRoot = (TemplatedPAComponentRoot) o; - return Objects.equals(this.data, templatedPAComponentRoot.data) && - Objects.equals(this.meta, templatedPAComponentRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java deleted file mode 100644 index eda156c8..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java +++ /dev/null @@ -1,201 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentSummary - */ -@JsonPropertyOrder({ - TemplatedPAComponentSummary.JSON_PROPERTY_DESCRIPTION, - TemplatedPAComponentSummary.JSON_PROPERTY_NAME, - TemplatedPAComponentSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, - TemplatedPAComponentSummary.JSON_PROPERTY_TYPE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; - private String parentTemplateId; - - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - - - public TemplatedPAComponentSummary description(String description) { - this.description = description; - return this; - } - - /** - * Get description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public TemplatedPAComponentSummary name(String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public TemplatedPAComponentSummary parentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - return this; - } - - /** - * Get parentTemplateId - * @return parentTemplateId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentTemplateId() { - return parentTemplateId; - } - - - public void setParentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - } - - - public TemplatedPAComponentSummary type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getType() { - return type; - } - - - public void setType(String type) { - this.type = type; - } - - - /** - * Return true if this TemplatedPAComponentSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentSummary templatedPAComponentSummary = (TemplatedPAComponentSummary) o; - return Objects.equals(this.description, templatedPAComponentSummary.description) && - Objects.equals(this.name, templatedPAComponentSummary.name) && - Objects.equals(this.parentTemplateId, templatedPAComponentSummary.parentTemplateId) && - Objects.equals(this.type, templatedPAComponentSummary.type); - } - - @Override - public int hashCode() { - return Objects.hash(description, name, parentTemplateId, type); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentSummary {\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java deleted file mode 100644 index b6000732..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplatedPAComponentSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentSummaryRoot - */ -@JsonPropertyOrder({ - TemplatedPAComponentSummaryRoot.JSON_PROPERTY_DATA, - TemplatedPAComponentSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public TemplatedPAComponentSummaryRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public TemplatedPAComponentSummaryRoot putDataItem(String key, TemplatedPAComponentSummary dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public TemplatedPAComponentSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this TemplatedPAComponentSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentSummaryRoot templatedPAComponentSummaryRoot = (TemplatedPAComponentSummaryRoot) o; - return Objects.equals(this.data, templatedPAComponentSummaryRoot.data) && - Objects.equals(this.meta, templatedPAComponentSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java deleted file mode 100644 index 8f21bcb0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java +++ /dev/null @@ -1,172 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PAComponentData; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentUpdateParameters - */ -@JsonPropertyOrder({ - TemplatedPAComponentUpdateParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, - TemplatedPAComponentUpdateParameters.JSON_PROPERTY_DESCRIPTION, - TemplatedPAComponentUpdateParameters.JSON_PROPERTY_COMPONENT_DATA -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentUpdateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; - private String parentTemplateId; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; - private PAComponentData componentData; - - - public TemplatedPAComponentUpdateParameters parentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - return this; - } - - /** - * Parent template id - * @return parentTemplateId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Parent template id") - @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getParentTemplateId() { - return parentTemplateId; - } - - - public void setParentTemplateId(String parentTemplateId) { - this.parentTemplateId = parentTemplateId; - } - - - public TemplatedPAComponentUpdateParameters description(String description) { - this.description = description; - return this; - } - - /** - * Component description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Component description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public TemplatedPAComponentUpdateParameters componentData(PAComponentData componentData) { - this.componentData = componentData; - return this; - } - - /** - * Get componentData - * @return componentData - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PAComponentData getComponentData() { - return componentData; - } - - - public void setComponentData(PAComponentData componentData) { - this.componentData = componentData; - } - - - /** - * Return true if this TemplatedPAComponentUpdateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentUpdateParameters templatedPAComponentUpdateParameters = (TemplatedPAComponentUpdateParameters) o; - return Objects.equals(this.parentTemplateId, templatedPAComponentUpdateParameters.parentTemplateId) && - Objects.equals(this.description, templatedPAComponentUpdateParameters.description) && - Objects.equals(this.componentData, templatedPAComponentUpdateParameters.componentData); - } - - @Override - public int hashCode() { - return Objects.hash(parentTemplateId, description, componentData); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentUpdateParameters {\n"); - sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java deleted file mode 100644 index 791fadb0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * TemplatedPAComponentUpdateParametersRoot - */ -@JsonPropertyOrder({ - TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_DATA, - TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentUpdateParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private TemplatedPAComponentUpdateParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public TemplatedPAComponentUpdateParametersRoot data(TemplatedPAComponentUpdateParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public TemplatedPAComponentUpdateParameters getData() { - return data; - } - - - public void setData(TemplatedPAComponentUpdateParameters data) { - this.data = data; - } - - - public TemplatedPAComponentUpdateParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this TemplatedPAComponentUpdateParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot = (TemplatedPAComponentUpdateParametersRoot) o; - return Objects.equals(this.data, templatedPAComponentUpdateParametersRoot.data) && - Objects.equals(this.meta, templatedPAComponentUpdateParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentUpdateParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java deleted file mode 100644 index 5c840c05..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java +++ /dev/null @@ -1,599 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationColumn; -import factset.analyticsapi.engines.models.PACalculationDataSources; -import factset.analyticsapi.engines.models.PACalculationGroup; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplate - */ -@JsonPropertyOrder({ - UnlinkedPATemplate.JSON_PROPERTY_ID, - UnlinkedPATemplate.JSON_PROPERTY_DIRECTORY, - UnlinkedPATemplate.JSON_PROPERTY_TEMPLATE_TYPE_ID, - UnlinkedPATemplate.JSON_PROPERTY_SNAPSHOT, - UnlinkedPATemplate.JSON_PROPERTY_ACCOUNTS, - UnlinkedPATemplate.JSON_PROPERTY_BENCHMARKS, - UnlinkedPATemplate.JSON_PROPERTY_COLUMNS, - UnlinkedPATemplate.JSON_PROPERTY_DATES, - UnlinkedPATemplate.JSON_PROPERTY_GROUPS, - UnlinkedPATemplate.JSON_PROPERTY_DATASOURCES, - UnlinkedPATemplate.JSON_PROPERTY_CURRENCYISOCODE, - UnlinkedPATemplate.JSON_PROPERTY_COMPONENTDETAIL, - UnlinkedPATemplate.JSON_PROPERTY_CONTENT, - UnlinkedPATemplate.JSON_PROPERTY_DESCRIPTION, - UnlinkedPATemplate.JSON_PROPERTY_NAME, - UnlinkedPATemplate.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplate implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; - private String templateTypeId; - - public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; - private Boolean snapshot; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_DATASOURCES = "datasources"; - private PACalculationDataSources datasources; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; - private String componentdetail; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public UnlinkedPATemplate id(String id) { - this.id = id; - return this; - } - - /** - * Template id. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template id.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public UnlinkedPATemplate directory(String directory) { - this.directory = directory; - return this; - } - - /** - * Template directory. - * @return directory - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template directory.") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public UnlinkedPATemplate templateTypeId(String templateTypeId) { - this.templateTypeId = templateTypeId; - return this; - } - - /** - * Template type id - * @return templateTypeId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template type id") - @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTemplateTypeId() { - return templateTypeId; - } - - - public void setTemplateTypeId(String templateTypeId) { - this.templateTypeId = templateTypeId; - } - - - public UnlinkedPATemplate snapshot(Boolean snapshot) { - this.snapshot = snapshot; - return this; - } - - /** - * snapshot. - * @return snapshot - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "snapshot.") - @JsonProperty(JSON_PROPERTY_SNAPSHOT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSnapshot() { - return snapshot; - } - - - public void setSnapshot(Boolean snapshot) { - this.snapshot = snapshot; - } - - - public UnlinkedPATemplate accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public UnlinkedPATemplate addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public UnlinkedPATemplate benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public UnlinkedPATemplate addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public UnlinkedPATemplate columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public UnlinkedPATemplate addColumnsItem(PACalculationColumn columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of columns for the PA calculation - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of columns for the PA calculation") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public UnlinkedPATemplate dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public UnlinkedPATemplate groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public UnlinkedPATemplate addGroupsItem(PACalculationGroup groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of groupings for the PA calculation - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of groupings for the PA calculation") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public UnlinkedPATemplate datasources(PACalculationDataSources datasources) { - this.datasources = datasources; - return this; - } - - /** - * Get datasources - * @return datasources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATASOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACalculationDataSources getDatasources() { - return datasources; - } - - - public void setDatasources(PACalculationDataSources datasources) { - this.datasources = datasources; - } - - - public UnlinkedPATemplate currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Currency ISO code for calculation. - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Currency ISO code for calculation.") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public UnlinkedPATemplate componentdetail(String componentdetail) { - this.componentdetail = componentdetail; - return this; - } - - /** - * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. - * @return componentdetail - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") - @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getComponentdetail() { - return componentdetail; - } - - - public void setComponentdetail(String componentdetail) { - this.componentdetail = componentdetail; - } - - - public UnlinkedPATemplate content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - public UnlinkedPATemplate description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public UnlinkedPATemplate name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public UnlinkedPATemplate category(String category) { - this.category = category; - return this; - } - - /** - * Unlinked template category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this UnlinkedPATemplate object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplate unlinkedPATemplate = (UnlinkedPATemplate) o; - return Objects.equals(this.id, unlinkedPATemplate.id) && - Objects.equals(this.directory, unlinkedPATemplate.directory) && - Objects.equals(this.templateTypeId, unlinkedPATemplate.templateTypeId) && - Objects.equals(this.snapshot, unlinkedPATemplate.snapshot) && - Objects.equals(this.accounts, unlinkedPATemplate.accounts) && - Objects.equals(this.benchmarks, unlinkedPATemplate.benchmarks) && - Objects.equals(this.columns, unlinkedPATemplate.columns) && - Objects.equals(this.dates, unlinkedPATemplate.dates) && - Objects.equals(this.groups, unlinkedPATemplate.groups) && - Objects.equals(this.datasources, unlinkedPATemplate.datasources) && - Objects.equals(this.currencyisocode, unlinkedPATemplate.currencyisocode) && - Objects.equals(this.componentdetail, unlinkedPATemplate.componentdetail) && - Objects.equals(this.content, unlinkedPATemplate.content) && - Objects.equals(this.description, unlinkedPATemplate.description) && - Objects.equals(this.name, unlinkedPATemplate.name) && - Objects.equals(this.category, unlinkedPATemplate.category); - } - - @Override - public int hashCode() { - return Objects.hash(id, directory, templateTypeId, snapshot, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content, description, name, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplate {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); - sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java deleted file mode 100644 index 25f4268d..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateCategoryAndType - */ -@JsonPropertyOrder({ - UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_CATEGORY, - UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_NAME -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateCategoryAndType implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - - public UnlinkedPATemplateCategoryAndType category(String category) { - this.category = category; - return this; - } - - /** - * Unlinked template category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - public UnlinkedPATemplateCategoryAndType name(String name) { - this.name = name; - return this; - } - - /** - * Unlinked template type - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template type") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - /** - * Return true if this UnlinkedPATemplateCategoryAndType object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateCategoryAndType unlinkedPATemplateCategoryAndType = (UnlinkedPATemplateCategoryAndType) o; - return Objects.equals(this.category, unlinkedPATemplateCategoryAndType.category) && - Objects.equals(this.name, unlinkedPATemplateCategoryAndType.name); - } - - @Override - public int hashCode() { - return Objects.hash(category, name); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateCategoryAndType {\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java deleted file mode 100644 index 0145c0bc..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java +++ /dev/null @@ -1,279 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateColumnDetails; -import factset.analyticsapi.engines.models.UnlinkedPATemplateGroupDetails; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateCategoryAndTypeDetails - */ -@JsonPropertyOrder({ - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_ID, - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_COLUMNS, - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_GROUPS, - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_SNAPSHOT, - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_CATEGORY, - UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_NAME -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateCategoryAndTypeDetails implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; - private Boolean snapshot; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - - public UnlinkedPATemplateCategoryAndTypeDetails id(String id) { - this.id = id; - return this; - } - - /** - * Type Id - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Type Id") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public UnlinkedPATemplateCategoryAndTypeDetails columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public UnlinkedPATemplateCategoryAndTypeDetails addColumnsItem(UnlinkedPATemplateColumnDetails columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of default columns - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of default columns") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public UnlinkedPATemplateCategoryAndTypeDetails groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public UnlinkedPATemplateCategoryAndTypeDetails addGroupsItem(UnlinkedPATemplateGroupDetails groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of default groupings - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of default groupings") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public UnlinkedPATemplateCategoryAndTypeDetails snapshot(Boolean snapshot) { - this.snapshot = snapshot; - return this; - } - - /** - * Snapshot - * @return snapshot - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Snapshot") - @JsonProperty(JSON_PROPERTY_SNAPSHOT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSnapshot() { - return snapshot; - } - - - public void setSnapshot(Boolean snapshot) { - this.snapshot = snapshot; - } - - - public UnlinkedPATemplateCategoryAndTypeDetails category(String category) { - this.category = category; - return this; - } - - /** - * Unlinked template category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - public UnlinkedPATemplateCategoryAndTypeDetails name(String name) { - this.name = name; - return this; - } - - /** - * Unlinked template type - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template type") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - /** - * Return true if this UnlinkedPATemplateCategoryAndTypeDetails object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateCategoryAndTypeDetails unlinkedPATemplateCategoryAndTypeDetails = (UnlinkedPATemplateCategoryAndTypeDetails) o; - return Objects.equals(this.id, unlinkedPATemplateCategoryAndTypeDetails.id) && - Objects.equals(this.columns, unlinkedPATemplateCategoryAndTypeDetails.columns) && - Objects.equals(this.groups, unlinkedPATemplateCategoryAndTypeDetails.groups) && - Objects.equals(this.snapshot, unlinkedPATemplateCategoryAndTypeDetails.snapshot) && - Objects.equals(this.category, unlinkedPATemplateCategoryAndTypeDetails.category) && - Objects.equals(this.name, unlinkedPATemplateCategoryAndTypeDetails.name); - } - - @Override - public int hashCode() { - return Objects.hash(id, columns, groups, snapshot, category, name); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateCategoryAndTypeDetails {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java deleted file mode 100644 index 70e4a3b3..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetails; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateCategoryAndTypeDetailsRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateCategoryAndTypeDetailsRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private UnlinkedPATemplateCategoryAndTypeDetails data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateCategoryAndTypeDetailsRoot data(UnlinkedPATemplateCategoryAndTypeDetails data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UnlinkedPATemplateCategoryAndTypeDetails getData() { - return data; - } - - - public void setData(UnlinkedPATemplateCategoryAndTypeDetails data) { - this.data = data; - } - - - public UnlinkedPATemplateCategoryAndTypeDetailsRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateCategoryAndTypeDetailsRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateCategoryAndTypeDetailsRoot unlinkedPATemplateCategoryAndTypeDetailsRoot = (UnlinkedPATemplateCategoryAndTypeDetailsRoot) o; - return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeDetailsRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateCategoryAndTypeDetailsRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateCategoryAndTypeDetailsRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java deleted file mode 100644 index 48326bce..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndType; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateCategoryAndTypeRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateCategoryAndTypeRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateCategoryAndTypeRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public UnlinkedPATemplateCategoryAndTypeRoot putDataItem(String key, UnlinkedPATemplateCategoryAndType dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public UnlinkedPATemplateCategoryAndTypeRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateCategoryAndTypeRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateCategoryAndTypeRoot unlinkedPATemplateCategoryAndTypeRoot = (UnlinkedPATemplateCategoryAndTypeRoot) o; - return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateCategoryAndTypeRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateCategoryAndTypeRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java deleted file mode 100644 index f3dab968..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java +++ /dev/null @@ -1,179 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateColumnDetails - */ -@JsonPropertyOrder({ - UnlinkedPATemplateColumnDetails.JSON_PROPERTY_NAME, - UnlinkedPATemplateColumnDetails.JSON_PROPERTY_ID, - UnlinkedPATemplateColumnDetails.JSON_PROPERTY_STATISTICS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateColumnDetails implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_STATISTICS = "statistics"; - private java.util.List statistics = null; - - - public UnlinkedPATemplateColumnDetails name(String name) { - this.name = name; - return this; - } - - /** - * Unlinked template column name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template column name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public UnlinkedPATemplateColumnDetails id(String id) { - this.id = id; - return this; - } - - /** - * FactSet-defined or User-defined Column identifier. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "FactSet-defined or User-defined Column identifier.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public UnlinkedPATemplateColumnDetails statistics(java.util.List statistics) { - this.statistics = statistics; - return this; - } - - public UnlinkedPATemplateColumnDetails addStatisticsItem(String statisticsItem) { - if (this.statistics == null) { - this.statistics = new java.util.ArrayList(); - } - this.statistics.add(statisticsItem); - return this; - } - - /** - * Column Statistic identifier - * @return statistics - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Column Statistic identifier") - @JsonProperty(JSON_PROPERTY_STATISTICS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getStatistics() { - return statistics; - } - - - public void setStatistics(java.util.List statistics) { - this.statistics = statistics; - } - - - /** - * Return true if this UnlinkedPATemplateColumnDetails object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateColumnDetails unlinkedPATemplateColumnDetails = (UnlinkedPATemplateColumnDetails) o; - return Objects.equals(this.name, unlinkedPATemplateColumnDetails.name) && - Objects.equals(this.id, unlinkedPATemplateColumnDetails.id) && - Objects.equals(this.statistics, unlinkedPATemplateColumnDetails.statistics); - } - - @Override - public int hashCode() { - return Objects.hash(name, id, statistics); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateColumnDetails {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" statistics: ").append(toIndentedString(statistics)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java deleted file mode 100644 index 1366a2c5..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateGroupDetails - */ -@JsonPropertyOrder({ - UnlinkedPATemplateGroupDetails.JSON_PROPERTY_NAME, - UnlinkedPATemplateGroupDetails.JSON_PROPERTY_ID, - UnlinkedPATemplateGroupDetails.JSON_PROPERTY_FREQUENCY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateGroupDetails implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - - public UnlinkedPATemplateGroupDetails name(String name) { - this.name = name; - return this; - } - - /** - * Unlinked template group name - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template group name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public UnlinkedPATemplateGroupDetails id(String id) { - this.id = id; - return this; - } - - /** - * FactSet-defined or User-defined Group identifier. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "FactSet-defined or User-defined Group identifier.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public UnlinkedPATemplateGroupDetails frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Grouping frequency - * @return frequency - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Grouping frequency") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - /** - * Return true if this UnlinkedPATemplateGroupDetails object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateGroupDetails unlinkedPATemplateGroupDetails = (UnlinkedPATemplateGroupDetails) o; - return Objects.equals(this.name, unlinkedPATemplateGroupDetails.name) && - Objects.equals(this.id, unlinkedPATemplateGroupDetails.id) && - Objects.equals(this.frequency, unlinkedPATemplateGroupDetails.frequency); - } - - @Override - public int hashCode() { - return Objects.hash(name, id, frequency); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateGroupDetails {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java deleted file mode 100644 index 94277a1e..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java +++ /dev/null @@ -1,477 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationColumn; -import factset.analyticsapi.engines.models.PACalculationDataSources; -import factset.analyticsapi.engines.models.PACalculationGroup; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateParameters - */ -@JsonPropertyOrder({ - UnlinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, - UnlinkedPATemplateParameters.JSON_PROPERTY_TEMPLATE_TYPE_ID, - UnlinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, - UnlinkedPATemplateParameters.JSON_PROPERTY_ACCOUNTS, - UnlinkedPATemplateParameters.JSON_PROPERTY_BENCHMARKS, - UnlinkedPATemplateParameters.JSON_PROPERTY_COLUMNS, - UnlinkedPATemplateParameters.JSON_PROPERTY_DATES, - UnlinkedPATemplateParameters.JSON_PROPERTY_GROUPS, - UnlinkedPATemplateParameters.JSON_PROPERTY_DATASOURCES, - UnlinkedPATemplateParameters.JSON_PROPERTY_CURRENCYISOCODE, - UnlinkedPATemplateParameters.JSON_PROPERTY_COMPONENTDETAIL, - UnlinkedPATemplateParameters.JSON_PROPERTY_CONTENT -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; - private String templateTypeId; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_DATASOURCES = "datasources"; - private PACalculationDataSources datasources; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; - private String componentdetail; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - - public UnlinkedPATemplateParameters directory(String directory) { - this.directory = directory; - return this; - } - - /** - * The directory to create an unlinked PA template - * @return directory - **/ - @ApiModelProperty(required = true, value = "The directory to create an unlinked PA template") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getDirectory() { - return directory; - } - - - public void setDirectory(String directory) { - this.directory = directory; - } - - - public UnlinkedPATemplateParameters templateTypeId(String templateTypeId) { - this.templateTypeId = templateTypeId; - return this; - } - - /** - * Template type id - * @return templateTypeId - **/ - @ApiModelProperty(required = true, value = "Template type id") - @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getTemplateTypeId() { - return templateTypeId; - } - - - public void setTemplateTypeId(String templateTypeId) { - this.templateTypeId = templateTypeId; - } - - - public UnlinkedPATemplateParameters description(String description) { - this.description = description; - return this; - } - - /** - * Template description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public UnlinkedPATemplateParameters accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public UnlinkedPATemplateParameters addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public UnlinkedPATemplateParameters benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public UnlinkedPATemplateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public UnlinkedPATemplateParameters columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public UnlinkedPATemplateParameters addColumnsItem(PACalculationColumn columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of columns for the PA calculation - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of columns for the PA calculation") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public UnlinkedPATemplateParameters dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public UnlinkedPATemplateParameters groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public UnlinkedPATemplateParameters addGroupsItem(PACalculationGroup groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of groupings for the PA calculation - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of groupings for the PA calculation") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public UnlinkedPATemplateParameters datasources(PACalculationDataSources datasources) { - this.datasources = datasources; - return this; - } - - /** - * Get datasources - * @return datasources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATASOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACalculationDataSources getDatasources() { - return datasources; - } - - - public void setDatasources(PACalculationDataSources datasources) { - this.datasources = datasources; - } - - - public UnlinkedPATemplateParameters currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Currency ISO code for calculation. - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Currency ISO code for calculation.") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public UnlinkedPATemplateParameters componentdetail(String componentdetail) { - this.componentdetail = componentdetail; - return this; - } - - /** - * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. - * @return componentdetail - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") - @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getComponentdetail() { - return componentdetail; - } - - - public void setComponentdetail(String componentdetail) { - this.componentdetail = componentdetail; - } - - - public UnlinkedPATemplateParameters content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - /** - * Return true if this UnlinkedPATemplateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateParameters unlinkedPATemplateParameters = (UnlinkedPATemplateParameters) o; - return Objects.equals(this.directory, unlinkedPATemplateParameters.directory) && - Objects.equals(this.templateTypeId, unlinkedPATemplateParameters.templateTypeId) && - Objects.equals(this.description, unlinkedPATemplateParameters.description) && - Objects.equals(this.accounts, unlinkedPATemplateParameters.accounts) && - Objects.equals(this.benchmarks, unlinkedPATemplateParameters.benchmarks) && - Objects.equals(this.columns, unlinkedPATemplateParameters.columns) && - Objects.equals(this.dates, unlinkedPATemplateParameters.dates) && - Objects.equals(this.groups, unlinkedPATemplateParameters.groups) && - Objects.equals(this.datasources, unlinkedPATemplateParameters.datasources) && - Objects.equals(this.currencyisocode, unlinkedPATemplateParameters.currencyisocode) && - Objects.equals(this.componentdetail, unlinkedPATemplateParameters.componentdetail) && - Objects.equals(this.content, unlinkedPATemplateParameters.content); - } - - @Override - public int hashCode() { - return Objects.hash(directory, templateTypeId, description, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateParameters {\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); - sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java deleted file mode 100644 index 6a51f9eb..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateParametersRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private UnlinkedPATemplateParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateParametersRoot data(UnlinkedPATemplateParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UnlinkedPATemplateParameters getData() { - return data; - } - - - public void setData(UnlinkedPATemplateParameters data) { - this.data = data; - } - - - public UnlinkedPATemplateParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = (UnlinkedPATemplateParametersRoot) o; - return Objects.equals(this.data, unlinkedPATemplateParametersRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java deleted file mode 100644 index 80e1a7f0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java +++ /dev/null @@ -1,201 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplatePostSummary - */ -@JsonPropertyOrder({ - UnlinkedPATemplatePostSummary.JSON_PROPERTY_ID, - UnlinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, - UnlinkedPATemplatePostSummary.JSON_PROPERTY_NAME, - UnlinkedPATemplatePostSummary.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplatePostSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_ID = "id"; - private String id; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public UnlinkedPATemplatePostSummary id(String id) { - this.id = id; - return this; - } - - /** - * Template id. - * @return id - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template id.") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - - public UnlinkedPATemplatePostSummary description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public UnlinkedPATemplatePostSummary name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public UnlinkedPATemplatePostSummary category(String category) { - this.category = category; - return this; - } - - /** - * Unlinked template category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this UnlinkedPATemplatePostSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplatePostSummary unlinkedPATemplatePostSummary = (UnlinkedPATemplatePostSummary) o; - return Objects.equals(this.id, unlinkedPATemplatePostSummary.id) && - Objects.equals(this.description, unlinkedPATemplatePostSummary.description) && - Objects.equals(this.name, unlinkedPATemplatePostSummary.name) && - Objects.equals(this.category, unlinkedPATemplatePostSummary.category); - } - - @Override - public int hashCode() { - return Objects.hash(id, description, name, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplatePostSummary {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java deleted file mode 100644 index 5d8dda34..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplatePostSummaryRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplatePostSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private UnlinkedPATemplatePostSummary data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplatePostSummaryRoot data(UnlinkedPATemplatePostSummary data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UnlinkedPATemplatePostSummary getData() { - return data; - } - - - public void setData(UnlinkedPATemplatePostSummary data) { - this.data = data; - } - - - public UnlinkedPATemplatePostSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplatePostSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplatePostSummaryRoot unlinkedPATemplatePostSummaryRoot = (UnlinkedPATemplatePostSummaryRoot) o; - return Objects.equals(this.data, unlinkedPATemplatePostSummaryRoot.data) && - Objects.equals(this.meta, unlinkedPATemplatePostSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplatePostSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java deleted file mode 100644 index 642eac87..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplate; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private UnlinkedPATemplate data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateRoot data(UnlinkedPATemplate data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UnlinkedPATemplate getData() { - return data; - } - - - public void setData(UnlinkedPATemplate data) { - this.data = data; - } - - - public UnlinkedPATemplateRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateRoot unlinkedPATemplateRoot = (UnlinkedPATemplateRoot) o; - return Objects.equals(this.data, unlinkedPATemplateRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java deleted file mode 100644 index 22f4edd6..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateSummary - */ -@JsonPropertyOrder({ - UnlinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, - UnlinkedPATemplateSummary.JSON_PROPERTY_NAME, - UnlinkedPATemplateSummary.JSON_PROPERTY_CATEGORY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateSummary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_NAME = "name"; - private String name; - - public static final String JSON_PROPERTY_CATEGORY = "category"; - private String category; - - - public UnlinkedPATemplateSummary description(String description) { - this.description = description; - return this; - } - - /** - * Template description. - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description.") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public UnlinkedPATemplateSummary name(String name) { - this.name = name; - return this; - } - - /** - * Template name. - * @return name - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template name.") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - - public UnlinkedPATemplateSummary category(String category) { - this.category = category; - return this; - } - - /** - * Unlinked template category - * @return category - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Unlinked template category") - @JsonProperty(JSON_PROPERTY_CATEGORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCategory() { - return category; - } - - - public void setCategory(String category) { - this.category = category; - } - - - /** - * Return true if this UnlinkedPATemplateSummary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateSummary unlinkedPATemplateSummary = (UnlinkedPATemplateSummary) o; - return Objects.equals(this.description, unlinkedPATemplateSummary.description) && - Objects.equals(this.name, unlinkedPATemplateSummary.name) && - Objects.equals(this.category, unlinkedPATemplateSummary.category); - } - - @Override - public int hashCode() { - return Objects.hash(description, name, category); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateSummary {\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" category: ").append(toIndentedString(category)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java deleted file mode 100644 index 2eacaf4f..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateSummaryRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateSummaryRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public UnlinkedPATemplateSummaryRoot putDataItem(String key, UnlinkedPATemplateSummary dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public UnlinkedPATemplateSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateSummaryRoot unlinkedPATemplateSummaryRoot = (UnlinkedPATemplateSummaryRoot) o; - return Objects.equals(this.data, unlinkedPATemplateSummaryRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java deleted file mode 100644 index 98365ef4..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java +++ /dev/null @@ -1,419 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACalculationColumn; -import factset.analyticsapi.engines.models.PACalculationDataSources; -import factset.analyticsapi.engines.models.PACalculationGroup; -import factset.analyticsapi.engines.models.PADateParameters; -import factset.analyticsapi.engines.models.PAIdentifier; -import factset.analyticsapi.engines.models.TemplateContentTypes; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateUpdateParameters - */ -@JsonPropertyOrder({ - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_ACCOUNTS, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_BENCHMARKS, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COLUMNS, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DATES, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_GROUPS, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DATASOURCES, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CURRENCYISOCODE, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COMPONENTDETAIL, - UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateUpdateParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private java.util.List accounts = null; - - public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; - private java.util.List benchmarks = null; - - public static final String JSON_PROPERTY_COLUMNS = "columns"; - private java.util.List columns = null; - - public static final String JSON_PROPERTY_DATES = "dates"; - private PADateParameters dates; - - public static final String JSON_PROPERTY_GROUPS = "groups"; - private java.util.List groups = null; - - public static final String JSON_PROPERTY_DATASOURCES = "datasources"; - private PACalculationDataSources datasources; - - public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; - private String currencyisocode; - - public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; - private String componentdetail; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private TemplateContentTypes content; - - - public UnlinkedPATemplateUpdateParameters description(String description) { - this.description = description; - return this; - } - - /** - * Template description - * @return description - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Template description") - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - public void setDescription(String description) { - this.description = description; - } - - - public UnlinkedPATemplateUpdateParameters accounts(java.util.List accounts) { - this.accounts = accounts; - return this; - } - - public UnlinkedPATemplateUpdateParameters addAccountsItem(PAIdentifier accountsItem) { - if (this.accounts == null) { - this.accounts = new java.util.ArrayList(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * List of accounts - * @return accounts - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of accounts") - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAccounts() { - return accounts; - } - - - public void setAccounts(java.util.List accounts) { - this.accounts = accounts; - } - - - public UnlinkedPATemplateUpdateParameters benchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - return this; - } - - public UnlinkedPATemplateUpdateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { - if (this.benchmarks == null) { - this.benchmarks = new java.util.ArrayList(); - } - this.benchmarks.add(benchmarksItem); - return this; - } - - /** - * List of benchmarks - * @return benchmarks - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of benchmarks") - @JsonProperty(JSON_PROPERTY_BENCHMARKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getBenchmarks() { - return benchmarks; - } - - - public void setBenchmarks(java.util.List benchmarks) { - this.benchmarks = benchmarks; - } - - - public UnlinkedPATemplateUpdateParameters columns(java.util.List columns) { - this.columns = columns; - return this; - } - - public UnlinkedPATemplateUpdateParameters addColumnsItem(PACalculationColumn columnsItem) { - if (this.columns == null) { - this.columns = new java.util.ArrayList(); - } - this.columns.add(columnsItem); - return this; - } - - /** - * List of columns for the PA calculation - * @return columns - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of columns for the PA calculation") - @JsonProperty(JSON_PROPERTY_COLUMNS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getColumns() { - return columns; - } - - - public void setColumns(java.util.List columns) { - this.columns = columns; - } - - - public UnlinkedPATemplateUpdateParameters dates(PADateParameters dates) { - this.dates = dates; - return this; - } - - /** - * Get dates - * @return dates - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PADateParameters getDates() { - return dates; - } - - - public void setDates(PADateParameters dates) { - this.dates = dates; - } - - - public UnlinkedPATemplateUpdateParameters groups(java.util.List groups) { - this.groups = groups; - return this; - } - - public UnlinkedPATemplateUpdateParameters addGroupsItem(PACalculationGroup groupsItem) { - if (this.groups == null) { - this.groups = new java.util.ArrayList(); - } - this.groups.add(groupsItem); - return this; - } - - /** - * List of groupings for the PA calculation - * @return groups - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "List of groupings for the PA calculation") - @JsonProperty(JSON_PROPERTY_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getGroups() { - return groups; - } - - - public void setGroups(java.util.List groups) { - this.groups = groups; - } - - - public UnlinkedPATemplateUpdateParameters datasources(PACalculationDataSources datasources) { - this.datasources = datasources; - return this; - } - - /** - * Get datasources - * @return datasources - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATASOURCES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACalculationDataSources getDatasources() { - return datasources; - } - - - public void setDatasources(PACalculationDataSources datasources) { - this.datasources = datasources; - } - - - public UnlinkedPATemplateUpdateParameters currencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - return this; - } - - /** - * Currency ISO code for calculation. - * @return currencyisocode - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Currency ISO code for calculation.") - @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCurrencyisocode() { - return currencyisocode; - } - - - public void setCurrencyisocode(String currencyisocode) { - this.currencyisocode = currencyisocode; - } - - - public UnlinkedPATemplateUpdateParameters componentdetail(String componentdetail) { - this.componentdetail = componentdetail; - return this; - } - - /** - * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. - * @return componentdetail - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") - @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getComponentdetail() { - return componentdetail; - } - - - public void setComponentdetail(String componentdetail) { - this.componentdetail = componentdetail; - } - - - public UnlinkedPATemplateUpdateParameters content(TemplateContentTypes content) { - this.content = content; - return this; - } - - /** - * Get content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TemplateContentTypes getContent() { - return content; - } - - - public void setContent(TemplateContentTypes content) { - this.content = content; - } - - - /** - * Return true if this UnlinkedPATemplateUpdateParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateUpdateParameters unlinkedPATemplateUpdateParameters = (UnlinkedPATemplateUpdateParameters) o; - return Objects.equals(this.description, unlinkedPATemplateUpdateParameters.description) && - Objects.equals(this.accounts, unlinkedPATemplateUpdateParameters.accounts) && - Objects.equals(this.benchmarks, unlinkedPATemplateUpdateParameters.benchmarks) && - Objects.equals(this.columns, unlinkedPATemplateUpdateParameters.columns) && - Objects.equals(this.dates, unlinkedPATemplateUpdateParameters.dates) && - Objects.equals(this.groups, unlinkedPATemplateUpdateParameters.groups) && - Objects.equals(this.datasources, unlinkedPATemplateUpdateParameters.datasources) && - Objects.equals(this.currencyisocode, unlinkedPATemplateUpdateParameters.currencyisocode) && - Objects.equals(this.componentdetail, unlinkedPATemplateUpdateParameters.componentdetail) && - Objects.equals(this.content, unlinkedPATemplateUpdateParameters.content); - } - - @Override - public int hashCode() { - return Objects.hash(description, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateUpdateParameters {\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); - sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); - sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); - sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); - sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); - sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); - sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java deleted file mode 100644 index f761c68d..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * UnlinkedPATemplateUpdateParametersRoot - */ -@JsonPropertyOrder({ - UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, - UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class UnlinkedPATemplateUpdateParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private UnlinkedPATemplateUpdateParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public UnlinkedPATemplateUpdateParametersRoot data(UnlinkedPATemplateUpdateParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public UnlinkedPATemplateUpdateParameters getData() { - return data; - } - - - public void setData(UnlinkedPATemplateUpdateParameters data) { - this.data = data; - } - - - public UnlinkedPATemplateUpdateParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this UnlinkedPATemplateUpdateParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot = (UnlinkedPATemplateUpdateParametersRoot) o; - return Objects.equals(this.data, unlinkedPATemplateUpdateParametersRoot.data) && - Objects.equals(this.meta, unlinkedPATemplateUpdateParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UnlinkedPATemplateUpdateParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java new file mode 100644 index 00000000..6d7a9982 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * VaultAttributionLoaderResponse + */ +@JsonPropertyOrder({ + VaultAttributionLoaderResponse.JSON_PROPERTY_PROCESS_ID, + VaultAttributionLoaderResponse.JSON_PROPERTY_GROUP_ID, + VaultAttributionLoaderResponse.JSON_PROPERTY_OBJECT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class VaultAttributionLoaderResponse implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PROCESS_ID = "processId"; + private String processId; + + public static final String JSON_PROPERTY_GROUP_ID = "groupId"; + private String groupId; + + public static final String JSON_PROPERTY_OBJECT_ID = "objectId"; + private String objectId; + + + public VaultAttributionLoaderResponse processId(String processId) { + this.processId = processId; + return this; + } + + /** + * ProcessId. + * @return processId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "ProcessId.") + @JsonProperty(JSON_PROPERTY_PROCESS_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getProcessId() { + return processId; + } + + + public void setProcessId(String processId) { + this.processId = processId; + } + + + public VaultAttributionLoaderResponse groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * GroupId. + * @return groupId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "GroupId.") + @JsonProperty(JSON_PROPERTY_GROUP_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroupId() { + return groupId; + } + + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + + public VaultAttributionLoaderResponse objectId(String objectId) { + this.objectId = objectId; + return this; + } + + /** + * ObjectId. + * @return objectId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "ObjectId.") + @JsonProperty(JSON_PROPERTY_OBJECT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getObjectId() { + return objectId; + } + + + public void setObjectId(String objectId) { + this.objectId = objectId; + } + + + /** + * Return true if this VaultAttributionLoaderResponse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + VaultAttributionLoaderResponse vaultAttributionLoaderResponse = (VaultAttributionLoaderResponse) o; + return Objects.equals(this.processId, vaultAttributionLoaderResponse.processId) && + Objects.equals(this.groupId, vaultAttributionLoaderResponse.groupId) && + Objects.equals(this.objectId, vaultAttributionLoaderResponse.objectId); + } + + @Override + public int hashCode() { + return Objects.hash(processId, groupId, objectId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class VaultAttributionLoaderResponse {\n"); + sb.append(" processId: ").append(toIndentedString(processId)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" objectId: ").append(toIndentedString(objectId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java similarity index 73% rename from auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java rename to auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java index ec60b30c..d5c0bff0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.TemplatedPAComponentParameters; +import factset.analyticsapi.engines.models.VaultAttributionLoaderResponse; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -31,24 +31,24 @@ /** - * TemplatedPAComponentParametersRoot + * VaultAttributionLoaderResponseRoot */ @JsonPropertyOrder({ - TemplatedPAComponentParametersRoot.JSON_PROPERTY_DATA, - TemplatedPAComponentParametersRoot.JSON_PROPERTY_META + VaultAttributionLoaderResponseRoot.JSON_PROPERTY_DATA, + VaultAttributionLoaderResponseRoot.JSON_PROPERTY_META }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class TemplatedPAComponentParametersRoot implements Serializable { +public class VaultAttributionLoaderResponseRoot implements Serializable { private static final long serialVersionUID = 1L; public static final String JSON_PROPERTY_DATA = "data"; - private TemplatedPAComponentParameters data; + private VaultAttributionLoaderResponse data; public static final String JSON_PROPERTY_META = "meta"; private Object meta; - public TemplatedPAComponentParametersRoot data(TemplatedPAComponentParameters data) { + public VaultAttributionLoaderResponseRoot data(VaultAttributionLoaderResponse data) { this.data = data; return this; } @@ -61,17 +61,17 @@ public TemplatedPAComponentParametersRoot data(TemplatedPAComponentParameters da @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public TemplatedPAComponentParameters getData() { + public VaultAttributionLoaderResponse getData() { return data; } - public void setData(TemplatedPAComponentParameters data) { + public void setData(VaultAttributionLoaderResponse data) { this.data = data; } - public TemplatedPAComponentParametersRoot meta(Object meta) { + public VaultAttributionLoaderResponseRoot meta(Object meta) { this.meta = meta; return this; } @@ -96,7 +96,7 @@ public void setMeta(Object meta) { /** - * Return true if this TemplatedPAComponentParametersRoot object is equal to o. + * Return true if this VaultAttributionLoaderResponseRoot object is equal to o. */ @Override public boolean equals(Object o) { @@ -106,9 +106,9 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = (TemplatedPAComponentParametersRoot) o; - return Objects.equals(this.data, templatedPAComponentParametersRoot.data) && - Objects.equals(this.meta, templatedPAComponentParametersRoot.meta); + VaultAttributionLoaderResponseRoot vaultAttributionLoaderResponseRoot = (VaultAttributionLoaderResponseRoot) o; + return Objects.equals(this.data, vaultAttributionLoaderResponseRoot.data) && + Objects.equals(this.meta, vaultAttributionLoaderResponseRoot.meta); } @Override @@ -119,7 +119,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TemplatedPAComponentParametersRoot {\n"); + sb.append("class VaultAttributionLoaderResponseRoot {\n"); sb.append(" data: ").append(toIndentedString(data)).append("\n"); sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); sb.append("}"); From bfb6de19ae8af9f20f8929f34ae6d6a5977d7adf Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Wed, 15 Oct 2025 18:04:26 +0000 Subject: [PATCH 02/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- auto-generated-sdk/.openapi-generator/FILES | 174 + auto-generated-sdk/README.md | 124 + auto-generated-sdk/api/openapi.yaml | 32779 ++++++++++++---- auto-generated-sdk/docs/Column.md | 20 + auto-generated-sdk/docs/ColumnRoot.md | 18 + auto-generated-sdk/docs/ColumnStatistic.md | 17 + .../docs/ColumnStatisticRoot.md | 18 + .../docs/ColumnStatisticsApi.md | 87 + auto-generated-sdk/docs/ColumnSummary.md | 20 + auto-generated-sdk/docs/ColumnSummaryRoot.md | 18 + auto-generated-sdk/docs/ColumnsApi.md | 179 + auto-generated-sdk/docs/ComponentsApi.md | 168 + auto-generated-sdk/docs/ConfigurationsApi.md | 83 + auto-generated-sdk/docs/DatesApi.md | 90 + auto-generated-sdk/docs/DocumentsApi.md | 84 + auto-generated-sdk/docs/FPOAccount.md | 19 + auto-generated-sdk/docs/FPOObjective.md | 27 + .../docs/FPOOptimizationParameters.md | 20 + .../docs/FPOOptimizationParametersRoot.md | 18 + .../docs/FPOOptimizerStrategy.md | 18 + .../docs/FPOOptimizerStrategyOverrides.md | 29 + auto-generated-sdk/docs/FpoOptimizerApi.md | 527 + auto-generated-sdk/docs/FrequenciesApi.md | 78 + auto-generated-sdk/docs/Group.md | 19 + auto-generated-sdk/docs/GroupRoot.md | 18 + auto-generated-sdk/docs/GroupsApi.md | 165 + auto-generated-sdk/docs/LinkedPATemplate.md | 23 + .../docs/LinkedPATemplateParameters.md | 20 + .../docs/LinkedPATemplateParametersRoot.md | 18 + .../docs/LinkedPATemplatePostSummary.md | 20 + .../docs/LinkedPATemplatePostSummaryRoot.md | 18 + .../docs/LinkedPATemplateRoot.md | 18 + .../docs/LinkedPATemplateSummary.md | 19 + .../docs/LinkedPATemplateSummaryRoot.md | 18 + .../docs/LinkedPATemplateUpdateParameters.md | 19 + .../LinkedPATemplateUpdateParametersRoot.md | 18 + .../docs/LinkedPaTemplatesApi.md | 460 + auto-generated-sdk/docs/Metadata.md | 22 + .../docs/PACalculationColumn.md | 18 + .../docs/PACalculationDataSources.md | 19 + auto-generated-sdk/docs/PACalculationGroup.md | 18 + .../docs/PACalculationParameters.md | 25 + .../docs/PACalculationParametersRoot.md | 18 + .../docs/PACalculationPricingSource.md | 17 + auto-generated-sdk/docs/PACommentary.md | 19 + .../docs/PACommentaryConfigurationSummary.md | 18 + .../PACommentaryConfigurationSummaryRoot.md | 18 + auto-generated-sdk/docs/PACommentaryDate.md | 18 + .../docs/PACommentaryGetStatus.md | 28 + .../docs/PACommentaryGetStatusRoot.md | 18 + .../docs/PACommentaryParameters.md | 17 + .../docs/PACommentaryParametersRoot.md | 18 + auto-generated-sdk/docs/PACommentaryRoot.md | 18 + auto-generated-sdk/docs/PACommentaryStatus.md | 29 + .../docs/PACommentaryStatusRoot.md | 18 + auto-generated-sdk/docs/PAComponent.md | 25 + auto-generated-sdk/docs/PAComponentData.md | 24 + auto-generated-sdk/docs/PAComponentRoot.md | 18 + auto-generated-sdk/docs/PADateParameters.md | 20 + auto-generated-sdk/docs/PAIdentifier.md | 18 + auto-generated-sdk/docs/PAPricingSource.md | 19 + .../docs/PAPricingSourceRoot.md | 18 + auto-generated-sdk/docs/PaCalculationsApi.md | 920 + auto-generated-sdk/docs/PaDoc.md | 17 + auto-generated-sdk/docs/PricingSourcesApi.md | 97 + auto-generated-sdk/docs/Section.md | 20 + .../docs/StrategyDocumentsApi.md | 84 + .../docs/TemplateContentTypes.md | 19 + .../docs/TemplatedPAComponent.md | 24 + .../docs/TemplatedPAComponentParameters.md | 20 + .../TemplatedPAComponentParametersRoot.md | 18 + .../docs/TemplatedPAComponentPostSummary.md | 21 + .../TemplatedPAComponentPostSummaryRoot.md | 18 + .../docs/TemplatedPAComponentRoot.md | 18 + .../docs/TemplatedPAComponentSummary.md | 20 + .../docs/TemplatedPAComponentSummaryRoot.md | 18 + .../TemplatedPAComponentUpdateParameters.md | 19 + ...emplatedPAComponentUpdateParametersRoot.md | 18 + .../docs/TemplatedPaComponentsApi.md | 467 + auto-generated-sdk/docs/UnlinkedPATemplate.md | 32 + .../docs/UnlinkedPATemplateCategoryAndType.md | 18 + ...nlinkedPATemplateCategoryAndTypeDetails.md | 22 + ...kedPATemplateCategoryAndTypeDetailsRoot.md | 18 + .../UnlinkedPATemplateCategoryAndTypeRoot.md | 18 + .../docs/UnlinkedPATemplateColumnDetails.md | 19 + .../docs/UnlinkedPATemplateGroupDetails.md | 19 + .../docs/UnlinkedPATemplateParameters.md | 28 + .../docs/UnlinkedPATemplateParametersRoot.md | 18 + .../docs/UnlinkedPATemplatePostSummary.md | 20 + .../docs/UnlinkedPATemplatePostSummaryRoot.md | 18 + .../docs/UnlinkedPATemplateRoot.md | 18 + .../docs/UnlinkedPATemplateSummary.md | 19 + .../docs/UnlinkedPATemplateSummaryRoot.md | 18 + .../UnlinkedPATemplateUpdateParameters.md | 26 + .../UnlinkedPATemplateUpdateParametersRoot.md | 18 + .../docs/UnlinkedPaTemplatesApi.md | 648 + .../engines/api/ColumnStatisticsApi.java | 123 + .../analyticsapi/engines/api/ColumnsApi.java | 223 + .../engines/api/ComponentsApi.java | 179 + .../engines/api/ConfigurationsApi.java | 87 + .../analyticsapi/engines/api/DatesApi.java | 108 + .../engines/api/DocumentsApi.java | 89 + .../engines/api/FpoOptimizerApi.java | 592 + .../engines/api/FrequenciesApi.java | 75 + .../analyticsapi/engines/api/GroupsApi.java | 199 + .../engines/api/LinkedPaTemplatesApi.java | 500 + .../engines/api/PaCalculationsApi.java | 974 + .../engines/api/PricingSourcesApi.java | 139 + .../engines/api/StrategyDocumentsApi.java | 89 + .../engines/api/TemplatedPaComponentsApi.java | 496 + .../engines/api/UnlinkedPaTemplatesApi.java | 658 + .../analyticsapi/engines/models/Column.java | 209 + .../engines/models/ColumnRoot.java | 141 + .../engines/models/ColumnStatistic.java | 111 + .../engines/models/ColumnStatisticRoot.java | 146 + .../engines/models/ColumnSummary.java | 172 + .../engines/models/ColumnSummaryRoot.java | 146 + .../engines/models/FPOAccount.java | 172 + .../engines/models/FPOObjective.java | 184 + .../models/FPOOptimizationParameters.java | 203 + .../models/FPOOptimizationParametersRoot.java | 142 + .../engines/models/FPOOptimizerStrategy.java | 141 + .../models/FPOOptimizerStrategyOverrides.java | 245 + .../analyticsapi/engines/models/Group.java | 171 + .../engines/models/GroupRoot.java | 146 + .../engines/models/LinkedPATemplate.java | 292 + .../models/LinkedPATemplateParameters.java | 200 + .../LinkedPATemplateParametersRoot.java | 141 + .../models/LinkedPATemplatePostSummary.java | 201 + .../LinkedPATemplatePostSummaryRoot.java | 141 + .../engines/models/LinkedPATemplateRoot.java | 141 + .../models/LinkedPATemplateSummary.java | 171 + .../models/LinkedPATemplateSummaryRoot.java | 146 + .../LinkedPATemplateUpdateParameters.java | 172 + .../LinkedPATemplateUpdateParametersRoot.java | 141 + .../analyticsapi/engines/models/Metadata.java | 262 + .../engines/models/PACalculationColumn.java | 149 + .../models/PACalculationDataSources.java | 188 + .../engines/models/PACalculationGroup.java | 141 + .../models/PACalculationParameters.java | 387 + .../models/PACalculationParametersRoot.java | 151 + .../models/PACalculationPricingSource.java | 111 + .../engines/models/PACommentary.java | 180 + .../PACommentaryConfigurationSummary.java | 141 + .../PACommentaryConfigurationSummaryRoot.java | 146 + .../engines/models/PACommentaryDate.java | 141 + .../engines/models/PACommentaryGetStatus.java | 206 + .../models/PACommentaryGetStatusRoot.java | 141 + .../models/PACommentaryParameters.java | 111 + .../models/PACommentaryParametersRoot.java | 141 + .../engines/models/PACommentaryRoot.java | 141 + .../engines/models/PACommentaryStatus.java | 236 + .../models/PACommentaryStatusRoot.java | 141 + .../engines/models/PAComponent.java | 369 + .../engines/models/PAComponentData.java | 358 + .../engines/models/PAComponentRoot.java | 141 + .../engines/models/PADateParameters.java | 170 + .../engines/models/PAIdentifier.java | 140 + .../engines/models/PAPricingSource.java | 171 + .../engines/models/PAPricingSourceRoot.java | 146 + .../analyticsapi/engines/models/PaDoc.java | 110 + .../analyticsapi/engines/models/Section.java | 210 + .../engines/models/TemplateContentTypes.java | 195 + .../engines/models/TemplatedPAComponent.java | 322 + .../TemplatedPAComponentParameters.java | 200 + .../TemplatedPAComponentParametersRoot.java | 141 + .../TemplatedPAComponentPostSummary.java | 231 + .../TemplatedPAComponentPostSummaryRoot.java | 141 + .../models/TemplatedPAComponentRoot.java | 141 + .../models/TemplatedPAComponentSummary.java | 201 + .../TemplatedPAComponentSummaryRoot.java | 146 + .../TemplatedPAComponentUpdateParameters.java | 172 + ...platedPAComponentUpdateParametersRoot.java | 141 + .../engines/models/UnlinkedPATemplate.java | 599 + .../UnlinkedPATemplateCategoryAndType.java | 141 + ...inkedPATemplateCategoryAndTypeDetails.java | 279 + ...dPATemplateCategoryAndTypeDetailsRoot.java | 141 + ...UnlinkedPATemplateCategoryAndTypeRoot.java | 146 + .../UnlinkedPATemplateColumnDetails.java | 179 + .../UnlinkedPATemplateGroupDetails.java | 171 + .../models/UnlinkedPATemplateParameters.java | 477 + .../UnlinkedPATemplateParametersRoot.java | 141 + .../models/UnlinkedPATemplatePostSummary.java | 201 + .../UnlinkedPATemplatePostSummaryRoot.java | 141 + .../models/UnlinkedPATemplateRoot.java | 141 + .../models/UnlinkedPATemplateSummary.java | 171 + .../models/UnlinkedPATemplateSummaryRoot.java | 146 + .../UnlinkedPATemplateUpdateParameters.java | 419 + ...nlinkedPATemplateUpdateParametersRoot.java | 141 + 189 files changed, 49785 insertions(+), 8176 deletions(-) create mode 100644 auto-generated-sdk/docs/Column.md create mode 100644 auto-generated-sdk/docs/ColumnRoot.md create mode 100644 auto-generated-sdk/docs/ColumnStatistic.md create mode 100644 auto-generated-sdk/docs/ColumnStatisticRoot.md create mode 100644 auto-generated-sdk/docs/ColumnStatisticsApi.md create mode 100644 auto-generated-sdk/docs/ColumnSummary.md create mode 100644 auto-generated-sdk/docs/ColumnSummaryRoot.md create mode 100644 auto-generated-sdk/docs/ColumnsApi.md create mode 100644 auto-generated-sdk/docs/FPOAccount.md create mode 100644 auto-generated-sdk/docs/FPOObjective.md create mode 100644 auto-generated-sdk/docs/FPOOptimizationParameters.md create mode 100644 auto-generated-sdk/docs/FPOOptimizationParametersRoot.md create mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategy.md create mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md create mode 100644 auto-generated-sdk/docs/FpoOptimizerApi.md create mode 100644 auto-generated-sdk/docs/Group.md create mode 100644 auto-generated-sdk/docs/GroupRoot.md create mode 100644 auto-generated-sdk/docs/GroupsApi.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplate.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateParameters.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummary.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummary.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPaTemplatesApi.md create mode 100644 auto-generated-sdk/docs/Metadata.md create mode 100644 auto-generated-sdk/docs/PACalculationColumn.md create mode 100644 auto-generated-sdk/docs/PACalculationDataSources.md create mode 100644 auto-generated-sdk/docs/PACalculationGroup.md create mode 100644 auto-generated-sdk/docs/PACalculationParameters.md create mode 100644 auto-generated-sdk/docs/PACalculationParametersRoot.md create mode 100644 auto-generated-sdk/docs/PACalculationPricingSource.md create mode 100644 auto-generated-sdk/docs/PACommentary.md create mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummary.md create mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryDate.md create mode 100644 auto-generated-sdk/docs/PACommentaryGetStatus.md create mode 100644 auto-generated-sdk/docs/PACommentaryGetStatusRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryParameters.md create mode 100644 auto-generated-sdk/docs/PACommentaryParametersRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryStatus.md create mode 100644 auto-generated-sdk/docs/PACommentaryStatusRoot.md create mode 100644 auto-generated-sdk/docs/PAComponent.md create mode 100644 auto-generated-sdk/docs/PAComponentData.md create mode 100644 auto-generated-sdk/docs/PAComponentRoot.md create mode 100644 auto-generated-sdk/docs/PADateParameters.md create mode 100644 auto-generated-sdk/docs/PAIdentifier.md create mode 100644 auto-generated-sdk/docs/PAPricingSource.md create mode 100644 auto-generated-sdk/docs/PAPricingSourceRoot.md create mode 100644 auto-generated-sdk/docs/PaCalculationsApi.md create mode 100644 auto-generated-sdk/docs/PaDoc.md create mode 100644 auto-generated-sdk/docs/PricingSourcesApi.md create mode 100644 auto-generated-sdk/docs/Section.md create mode 100644 auto-generated-sdk/docs/TemplateContentTypes.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponent.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParameters.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummary.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPaComponentsApi.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplate.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParameters.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummary.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index d4327b1c..f3a29001 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -37,6 +37,14 @@ docs/CalculationUnitStatusMeta.md docs/CalculationsSummary.md docs/CalculationsSummaryRoot.md docs/ClientErrorResponse.md +docs/Column.md +docs/ColumnRoot.md +docs/ColumnStatistic.md +docs/ColumnStatisticRoot.md +docs/ColumnStatisticsApi.md +docs/ColumnSummary.md +docs/ColumnSummaryRoot.md +docs/ColumnsApi.md docs/ComponentSummary.md docs/ComponentSummaryRoot.md docs/ComponentsApi.md @@ -85,11 +93,33 @@ docs/FIServicerAdvances.md docs/FIServicerAdvancesForSecurities.md docs/FIStructuredProductsForJobSettings.md docs/FIStructuredProductsForSecurities.md +docs/FPOAccount.md +docs/FPOObjective.md +docs/FPOOptimizationParameters.md +docs/FPOOptimizationParametersRoot.md +docs/FPOOptimizerStrategy.md +docs/FPOOptimizerStrategyOverrides.md docs/FiCalculationsApi.md docs/FiabCalculationsApi.md +docs/FpoOptimizerApi.md docs/FrequenciesApi.md docs/Frequency.md docs/FrequencyRoot.md +docs/Group.md +docs/GroupRoot.md +docs/GroupsApi.md +docs/LinkedPATemplate.md +docs/LinkedPATemplateParameters.md +docs/LinkedPATemplateParametersRoot.md +docs/LinkedPATemplatePostSummary.md +docs/LinkedPATemplatePostSummaryRoot.md +docs/LinkedPATemplateRoot.md +docs/LinkedPATemplateSummary.md +docs/LinkedPATemplateSummaryRoot.md +docs/LinkedPATemplateUpdateParameters.md +docs/LinkedPATemplateUpdateParametersRoot.md +docs/LinkedPaTemplatesApi.md +docs/Metadata.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerStrategy.md @@ -106,8 +136,35 @@ docs/OptimizerAccountOverrides.md docs/OptimizerOptimalHoldings.md docs/OptimizerOutputTypes.md docs/OptimizerTradesList.md +docs/PACalculationColumn.md +docs/PACalculationDataSources.md +docs/PACalculationGroup.md +docs/PACalculationParameters.md +docs/PACalculationParametersRoot.md +docs/PACalculationPricingSource.md +docs/PACommentary.md +docs/PACommentaryConfigurationSummary.md +docs/PACommentaryConfigurationSummaryRoot.md +docs/PACommentaryDate.md +docs/PACommentaryGetStatus.md +docs/PACommentaryGetStatusRoot.md +docs/PACommentaryParameters.md +docs/PACommentaryParametersRoot.md +docs/PACommentaryRoot.md +docs/PACommentaryStatus.md +docs/PACommentaryStatusRoot.md +docs/PAComponent.md +docs/PAComponentData.md +docs/PAComponentRoot.md +docs/PADateParameters.md +docs/PAIdentifier.md +docs/PAPricingSource.md +docs/PAPricingSourceRoot.md +docs/PaCalculationsApi.md +docs/PaDoc.md docs/PaginationInfo.md docs/PaginationMeta.md +docs/PricingSourcesApi.md docs/PubCalculationParameters.md docs/PubCalculationParametersRoot.md docs/PubCalculationsApi.md @@ -140,8 +197,38 @@ docs/SPARComponent.md docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md +docs/Section.md docs/SparCalculationsApi.md docs/StrategyDocumentsApi.md +docs/TemplateContentTypes.md +docs/TemplatedPAComponent.md +docs/TemplatedPAComponentParameters.md +docs/TemplatedPAComponentParametersRoot.md +docs/TemplatedPAComponentPostSummary.md +docs/TemplatedPAComponentPostSummaryRoot.md +docs/TemplatedPAComponentRoot.md +docs/TemplatedPAComponentSummary.md +docs/TemplatedPAComponentSummaryRoot.md +docs/TemplatedPAComponentUpdateParameters.md +docs/TemplatedPAComponentUpdateParametersRoot.md +docs/TemplatedPaComponentsApi.md +docs/UnlinkedPATemplate.md +docs/UnlinkedPATemplateCategoryAndType.md +docs/UnlinkedPATemplateCategoryAndTypeDetails.md +docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md +docs/UnlinkedPATemplateCategoryAndTypeRoot.md +docs/UnlinkedPATemplateColumnDetails.md +docs/UnlinkedPATemplateGroupDetails.md +docs/UnlinkedPATemplateParameters.md +docs/UnlinkedPATemplateParametersRoot.md +docs/UnlinkedPATemplatePostSummary.md +docs/UnlinkedPATemplatePostSummaryRoot.md +docs/UnlinkedPATemplateRoot.md +docs/UnlinkedPATemplateSummary.md +docs/UnlinkedPATemplateSummaryRoot.md +docs/UnlinkedPATemplateUpdateParameters.md +docs/UnlinkedPATemplateUpdateParametersRoot.md +docs/UnlinkedPaTemplatesApi.md docs/VaultAttributionLoaderApi.md docs/VaultAttributionLoaderResponse.md docs/VaultAttributionLoaderResponseRoot.md @@ -182,6 +269,8 @@ 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 src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -190,12 +279,19 @@ src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java +src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +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/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 @@ -230,6 +326,12 @@ src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java src/main/java/factset/analyticsapi/engines/models/CalculationsSummary.java src/main/java/factset/analyticsapi/engines/models/CalculationsSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java +src/main/java/factset/analyticsapi/engines/models/Column.java +src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java +src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java +src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java +src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java +src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java @@ -272,8 +374,27 @@ src/main/java/factset/analyticsapi/engines/models/FIServicerAdvances.java src/main/java/factset/analyticsapi/engines/models/FIServicerAdvancesForSecurities.java src/main/java/factset/analyticsapi/engines/models/FIStructuredProductsForJobSettings.java src/main/java/factset/analyticsapi/engines/models/FIStructuredProductsForSecurities.java +src/main/java/factset/analyticsapi/engines/models/FPOAccount.java +src/main/java/factset/analyticsapi/engines/models/FPOObjective.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java src/main/java/factset/analyticsapi/engines/models/Frequency.java src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java +src/main/java/factset/analyticsapi/engines/models/Group.java +src/main/java/factset/analyticsapi/engines/models/GroupRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/Metadata.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java @@ -289,6 +410,31 @@ src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java +src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java +src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java +src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java +src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java +src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java +src/main/java/factset/analyticsapi/engines/models/PACommentary.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java +src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java +src/main/java/factset/analyticsapi/engines/models/PAComponent.java +src/main/java/factset/analyticsapi/engines/models/PAComponentData.java +src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java +src/main/java/factset/analyticsapi/engines/models/PADateParameters.java +src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java +src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java +src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java +src/main/java/factset/analyticsapi/engines/models/PaDoc.java src/main/java/factset/analyticsapi/engines/models/PaginationInfo.java src/main/java/factset/analyticsapi/engines/models/PaginationMeta.java src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java @@ -321,6 +467,34 @@ src/main/java/factset/analyticsapi/engines/models/SPARComponent.java src/main/java/factset/analyticsapi/engines/models/SPARComponentRoot.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/Section.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 +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java +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 diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 4b27a563..d8b9256c 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -162,15 +162,23 @@ Class | Method | HTTP request | Description *BpmOptimizerApi* | [**getOptimizationStatusById**](docs/BpmOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/bpm/v3/optimizations/{id}/status | Get BPM optimization status by id *BpmOptimizerApi* | [**postAndOptimize**](docs/BpmOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/bpm/v3/optimizations | Create and Run BPM optimization *BpmOptimizerApi* | [**putAndOptimize**](docs/BpmOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/bpm/v3/optimizations/{id} | Create or Update BPM optimization and run it. +*ColumnStatisticsApi* | [**getPAColumnStatistics**](docs/ColumnStatisticsApi.md#getPAColumnStatistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics +*ColumnsApi* | [**getPAColumnById**](docs/ColumnsApi.md#getPAColumnById) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings +*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* | [**getSPARComponentById**](docs/ComponentsApi.md#getSPARComponentById) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id *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* | [**getPACommentaryConfigurations**](docs/ConfigurationsApi.md#getPACommentaryConfigurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory *ConfigurationsApi* | [**getVaultConfigurationById**](docs/ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**getVaultConfigurations**](docs/ConfigurationsApi.md#getVaultConfigurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**getCurrencies**](docs/CurrenciesApi.md#getCurrencies) | **GET** /analytics/lookups/v3/currencies | Get currencies +*DatesApi* | [**convertPADatesToAbsoluteFormat**](docs/DatesApi.md#convertPADatesToAbsoluteFormat) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format *DatesApi* | [**convertVaultDatesToAbsoluteFormat**](docs/DatesApi.md#convertVaultDatesToAbsoluteFormat) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format *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 @@ -183,14 +191,39 @@ Class | Method | HTTP request | Description *FiabCalculationsApi* | [**getCalculationById**](docs/FiabCalculationsApi.md#getCalculationById) | **GET** /analytics/engines/fiab/v1/calculations/{id} | Get FIAB calculation by id *FiabCalculationsApi* | [**getCalculationStatusSummaries**](docs/FiabCalculationsApi.md#getCalculationStatusSummaries) | **GET** /analytics/engines/fiab/v1/calculations | Get all FIAB calculation summaries *FiabCalculationsApi* | [**runCalculation**](docs/FiabCalculationsApi.md#runCalculation) | **POST** /analytics/engines/fiab/v1/calculations | Run FIAB calculation +*FpoOptimizerApi* | [**cancelOptimizationById**](docs/FpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id +*FpoOptimizerApi* | [**getOptimizationParameters**](docs/FpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id +*FpoOptimizerApi* | [**getOptimizationResult**](docs/FpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id +*FpoOptimizerApi* | [**getOptimizationStatusById**](docs/FpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id +*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 +*LinkedPaTemplatesApi* | [**createLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +*LinkedPaTemplatesApi* | [**deleteLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +*LinkedPaTemplatesApi* | [**getLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +*LinkedPaTemplatesApi* | [**getLinkedPATemplatesById**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +*LinkedPaTemplatesApi* | [**updateLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template *NpoOptimizerApi* | [**cancelOptimizationById**](docs/NpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/npo/v3/optimizations/{id} | Cancel NPO optimization by id *NpoOptimizerApi* | [**getOptimizationParameters**](docs/NpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/npo/v3/optimizations/{id} | Get NPO optimization parameters by id *NpoOptimizerApi* | [**getOptimizationResult**](docs/NpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/npo/v3/optimizations/{id}/result | Get NPO optimization result by id *NpoOptimizerApi* | [**getOptimizationStatusById**](docs/NpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/npo/v3/optimizations/{id}/status | Get NPO optimization status by id *NpoOptimizerApi* | [**postAndOptimize**](docs/NpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NpoOptimizerApi* | [**putAndOptimize**](docs/NpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. +*PaCalculationsApi* | [**cancelCalculationById**](docs/PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id +*PaCalculationsApi* | [**generatePAPortfolioCommentary**](docs/PaCalculationsApi.md#generatePAPortfolioCommentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. +*PaCalculationsApi* | [**getAllCalculations**](docs/PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations +*PaCalculationsApi* | [**getCalculationParameters**](docs/PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id +*PaCalculationsApi* | [**getCalculationStatusById**](docs/PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id +*PaCalculationsApi* | [**getCalculationUnitResultById**](docs/PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id +*PaCalculationsApi* | [**getPAPortfolioCommentaryResultById**](docs/PaCalculationsApi.md#getPAPortfolioCommentaryResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. +*PaCalculationsApi* | [**getPAPortfolioCommentaryStatusById**](docs/PaCalculationsApi.md#getPAPortfolioCommentaryStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. +*PaCalculationsApi* | [**postAndCalculate**](docs/PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation +*PaCalculationsApi* | [**putAndCalculate**](docs/PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. +*PricingSourcesApi* | [**getPAPricingSources**](docs/PricingSourcesApi.md#getPAPricingSources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources *PubCalculationsApi* | [**cancelCalculationById**](docs/PubCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pub/v3/calculations/{id} | Cancel Pub calculation by id *PubCalculationsApi* | [**getAllCalculations**](docs/PubCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pub/v3/calculations | Get all calculations *PubCalculationsApi* | [**getCalculationParameters**](docs/PubCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pub/v3/calculations/{id} | Get Pub calculation parameters by id @@ -216,7 +249,20 @@ Class | Method | HTTP request | Description *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 +*StrategyDocumentsApi* | [**getFPOStrategyDocuments**](docs/StrategyDocumentsApi.md#getFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**getNorthfieldStrategyDocuments**](docs/StrategyDocumentsApi.md#getNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory +*TemplatedPaComponentsApi* | [**createTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +*TemplatedPaComponentsApi* | [**deleteTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +*TemplatedPaComponentsApi* | [**getTemplatedPAComponentById**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +*TemplatedPaComponentsApi* | [**getTemplatedPAComponentsInPath**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +*TemplatedPaComponentsApi* | [**updateTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component +*UnlinkedPaTemplatesApi* | [**createUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +*UnlinkedPaTemplatesApi* | [**deleteUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +*UnlinkedPaTemplatesApi* | [**getDefaultUnlinkedPATemplateTypes**](docs/UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +*UnlinkedPaTemplatesApi* | [**getDetailsType**](docs/UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +*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 @@ -256,6 +302,12 @@ Class | Method | HTTP request | Description - [CalculationsSummary](docs/CalculationsSummary.md) - [CalculationsSummaryRoot](docs/CalculationsSummaryRoot.md) - [ClientErrorResponse](docs/ClientErrorResponse.md) + - [Column](docs/Column.md) + - [ColumnRoot](docs/ColumnRoot.md) + - [ColumnStatistic](docs/ColumnStatistic.md) + - [ColumnStatisticRoot](docs/ColumnStatisticRoot.md) + - [ColumnSummary](docs/ColumnSummary.md) + - [ColumnSummaryRoot](docs/ColumnSummaryRoot.md) - [ComponentSummary](docs/ComponentSummary.md) - [ComponentSummaryRoot](docs/ComponentSummaryRoot.md) - [ConfigurationAccount](docs/ConfigurationAccount.md) @@ -298,8 +350,27 @@ Class | Method | HTTP request | Description - [FIServicerAdvancesForSecurities](docs/FIServicerAdvancesForSecurities.md) - [FIStructuredProductsForJobSettings](docs/FIStructuredProductsForJobSettings.md) - [FIStructuredProductsForSecurities](docs/FIStructuredProductsForSecurities.md) + - [FPOAccount](docs/FPOAccount.md) + - [FPOObjective](docs/FPOObjective.md) + - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md) + - [FPOOptimizationParametersRoot](docs/FPOOptimizationParametersRoot.md) + - [FPOOptimizerStrategy](docs/FPOOptimizerStrategy.md) + - [FPOOptimizerStrategyOverrides](docs/FPOOptimizerStrategyOverrides.md) - [Frequency](docs/Frequency.md) - [FrequencyRoot](docs/FrequencyRoot.md) + - [Group](docs/Group.md) + - [GroupRoot](docs/GroupRoot.md) + - [LinkedPATemplate](docs/LinkedPATemplate.md) + - [LinkedPATemplateParameters](docs/LinkedPATemplateParameters.md) + - [LinkedPATemplateParametersRoot](docs/LinkedPATemplateParametersRoot.md) + - [LinkedPATemplatePostSummary](docs/LinkedPATemplatePostSummary.md) + - [LinkedPATemplatePostSummaryRoot](docs/LinkedPATemplatePostSummaryRoot.md) + - [LinkedPATemplateRoot](docs/LinkedPATemplateRoot.md) + - [LinkedPATemplateSummary](docs/LinkedPATemplateSummary.md) + - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) + - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) + - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) + - [Metadata](docs/Metadata.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -315,6 +386,31 @@ Class | Method | HTTP request | Description - [OptimizerOptimalHoldings](docs/OptimizerOptimalHoldings.md) - [OptimizerOutputTypes](docs/OptimizerOutputTypes.md) - [OptimizerTradesList](docs/OptimizerTradesList.md) + - [PACalculationColumn](docs/PACalculationColumn.md) + - [PACalculationDataSources](docs/PACalculationDataSources.md) + - [PACalculationGroup](docs/PACalculationGroup.md) + - [PACalculationParameters](docs/PACalculationParameters.md) + - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) + - [PACalculationPricingSource](docs/PACalculationPricingSource.md) + - [PACommentary](docs/PACommentary.md) + - [PACommentaryConfigurationSummary](docs/PACommentaryConfigurationSummary.md) + - [PACommentaryConfigurationSummaryRoot](docs/PACommentaryConfigurationSummaryRoot.md) + - [PACommentaryDate](docs/PACommentaryDate.md) + - [PACommentaryGetStatus](docs/PACommentaryGetStatus.md) + - [PACommentaryGetStatusRoot](docs/PACommentaryGetStatusRoot.md) + - [PACommentaryParameters](docs/PACommentaryParameters.md) + - [PACommentaryParametersRoot](docs/PACommentaryParametersRoot.md) + - [PACommentaryRoot](docs/PACommentaryRoot.md) + - [PACommentaryStatus](docs/PACommentaryStatus.md) + - [PACommentaryStatusRoot](docs/PACommentaryStatusRoot.md) + - [PAComponent](docs/PAComponent.md) + - [PAComponentData](docs/PAComponentData.md) + - [PAComponentRoot](docs/PAComponentRoot.md) + - [PADateParameters](docs/PADateParameters.md) + - [PAIdentifier](docs/PAIdentifier.md) + - [PAPricingSource](docs/PAPricingSource.md) + - [PAPricingSourceRoot](docs/PAPricingSourceRoot.md) + - [PaDoc](docs/PaDoc.md) - [PaginationInfo](docs/PaginationInfo.md) - [PaginationMeta](docs/PaginationMeta.md) - [PubCalculationParameters](docs/PubCalculationParameters.md) @@ -347,6 +443,34 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) + - [Section](docs/Section.md) + - [TemplateContentTypes](docs/TemplateContentTypes.md) + - [TemplatedPAComponent](docs/TemplatedPAComponent.md) + - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) + - [TemplatedPAComponentParametersRoot](docs/TemplatedPAComponentParametersRoot.md) + - [TemplatedPAComponentPostSummary](docs/TemplatedPAComponentPostSummary.md) + - [TemplatedPAComponentPostSummaryRoot](docs/TemplatedPAComponentPostSummaryRoot.md) + - [TemplatedPAComponentRoot](docs/TemplatedPAComponentRoot.md) + - [TemplatedPAComponentSummary](docs/TemplatedPAComponentSummary.md) + - [TemplatedPAComponentSummaryRoot](docs/TemplatedPAComponentSummaryRoot.md) + - [TemplatedPAComponentUpdateParameters](docs/TemplatedPAComponentUpdateParameters.md) + - [TemplatedPAComponentUpdateParametersRoot](docs/TemplatedPAComponentUpdateParametersRoot.md) + - [UnlinkedPATemplate](docs/UnlinkedPATemplate.md) + - [UnlinkedPATemplateCategoryAndType](docs/UnlinkedPATemplateCategoryAndType.md) + - [UnlinkedPATemplateCategoryAndTypeDetails](docs/UnlinkedPATemplateCategoryAndTypeDetails.md) + - [UnlinkedPATemplateCategoryAndTypeDetailsRoot](docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) + - [UnlinkedPATemplateCategoryAndTypeRoot](docs/UnlinkedPATemplateCategoryAndTypeRoot.md) + - [UnlinkedPATemplateColumnDetails](docs/UnlinkedPATemplateColumnDetails.md) + - [UnlinkedPATemplateGroupDetails](docs/UnlinkedPATemplateGroupDetails.md) + - [UnlinkedPATemplateParameters](docs/UnlinkedPATemplateParameters.md) + - [UnlinkedPATemplateParametersRoot](docs/UnlinkedPATemplateParametersRoot.md) + - [UnlinkedPATemplatePostSummary](docs/UnlinkedPATemplatePostSummary.md) + - [UnlinkedPATemplatePostSummaryRoot](docs/UnlinkedPATemplatePostSummaryRoot.md) + - [UnlinkedPATemplateRoot](docs/UnlinkedPATemplateRoot.md) + - [UnlinkedPATemplateSummary](docs/UnlinkedPATemplateSummary.md) + - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) + - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) + - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) diff --git a/auto-generated-sdk/api/openapi.yaml b/auto-generated-sdk/api/openapi.yaml index 3bf80c32..c08a1891 100644 --- a/auto-generated-sdk/api/openapi.yaml +++ b/auto-generated-sdk/api/openapi.yaml @@ -6730,20 +6730,42 @@ paths: - status-code: "200" response-type: ObjectRoot x-accepts: application/json - /analytics/engines/spar/v3/components: + /analytics/engines/pa/v3/columns: get: - description: This endpoint returns the list of SPAR components in a given SPAR - document. - operationId: getSPARComponents + description: This endpoint lists all the PA columns that can be applied to a + calculation. + operationId: getPAColumns parameters: - - description: Document Name + - description: Column name explode: true in: query - name: document - required: true + name: name + required: false schema: - description: Document Name - example: SPAR_DOCUMENTS:Factset Default Document + default: "" + description: Column name + example: Security Name + type: string + style: form + - description: Column category + explode: true + in: query + name: category + required: false + schema: + default: "" + description: Column category + type: string + style: form + - description: The directory to get the columns in + explode: true + in: query + name: directory + required: false + schema: + default: "" + description: The directory to get the columns in + example: Client type: string style: form responses: @@ -6751,49 +6773,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of SPAR components. - 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 provided or Invalid SPAR document name. + $ref: '#/components/schemas/ColumnSummaryRoot' + description: Expected response, returns a list of PA columns headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -6811,46 +6792,14 @@ 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: SPAR Document 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. + Age: + description: Standard HTTP header. Header will specify the age of columns + list cached response. 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 the age of + columns list cached response. + type: integer style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. @@ -6992,7 +6941,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. @@ -7029,27 +6978,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR components + summary: Get PA columns tags: - - Components + - Columns x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ComponentSummaryRoot + response-type: ColumnSummaryRoot x-accepts: application/json - /analytics/engines/spar/v3/components/{id}: + /analytics/engines/pa/v3/columns/{id}: get: - description: This endpoint returns the default settings of a SPAR component. - operationId: getSPARComponentById + description: This endpoint returns the default settings of a PA column. + operationId: getPAColumnById parameters: - - description: Unique identifier for a SPAR component + - description: Unique identifier for a column explode: false in: path name: id required: true schema: - description: Unique identifier for a SPAR component - example: 067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D + description: Unique identifier for a column + example: 2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7 type: string style: simple responses: @@ -7057,8 +7006,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SPARComponentRoot' - description: Expected response, returns the default settings of a SPAR component. + $ref: '#/components/schemas/ColumnRoot' + description: Expected response, returns settings of a PA column. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7076,6 +7025,15 @@ paths: available after successful authentication. type: string style: simple + Age: + description: Standard HTTP header. Header will specify the age of columns + list cached response. + explode: false + schema: + description: Standard HTTP header. Header will specify the age of + columns list cached response. + type: integer + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -7099,7 +7057,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid SPAR component id. + description: Invalid column Id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7140,7 +7098,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Component not found. + description: Column not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7335,120 +7293,26 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR component by id + summary: Get PA column settings tags: - - Components + - Columns x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: SPARComponentRoot + response-type: ColumnRoot x-accepts: application/json - /analytics/engines/vault/v3/components: + /analytics/engines/pa/v3/columnstatistics: get: - description: This endpoint returns the list of Vault components in a given Vault - document. - operationId: getVaultComponents - parameters: - - description: Document Name - explode: true - in: query - name: document - required: true - schema: - description: Document Name - example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT - type: string - style: form + description: This endpoint lists all the column statistics that can be applied + to a PA column. + operationId: getPAColumnStatistics responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of Vault components. - 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 provided or invalid Vault document - name. - 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: Vault Document not found. + $ref: '#/components/schemas/ColumnStatisticRoot' + description: Expected response, returns a list of PA column statistics headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7606,7 +7470,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. @@ -7643,37 +7507,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault components + summary: Get PA column statistics tags: - - Components + - ColumnStatistics x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ComponentSummaryRoot + response-type: ColumnStatisticRoot x-accepts: application/json - /analytics/engines/vault/v3/components/{id}: + /analytics/engines/pa/v3/components: get: - description: This endpoint returns the default settings of a Vault component. - operationId: getVaultComponentById + description: This endpoint returns the list of PA components in a given PA document. + operationId: getPAComponents parameters: - - description: Unique identifier for a vault component - explode: false - in: path - name: id + - description: Document Name + explode: true + in: query + name: document required: true schema: - description: Unique identifier for a vault component - example: AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D + description: Document Name + example: PA3_DOCUMENTS:DEFAULT 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/ComponentSummaryRoot' + description: Expected response, returns a list of PA components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7714,7 +7577,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Vault component id. + description: Invalid query parameter provided or Invalid PA document name. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7755,7 +7618,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault Component not found. + description: Document not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -7950,39 +7813,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault component by id + summary: Get PA components tags: - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultComponentRoot + response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/engines/vault/v3/configurations: + /analytics/engines/pa/v3/components/{id}: get: - description: This endpoint returns all the Vault configurations saved in the - provided account. - operationId: getVaultConfigurations + description: This endpoint returns the default settings of a PA component. + operationId: getPAComponentById parameters: - - description: Required account query parameter to filter configurations for - a specific account - explode: true - in: query - name: account + - description: Unique identifier for a PA component + explode: false + in: path + name: id required: true schema: - description: Required account query parameter to filter configurations for - a specific account - example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT + description: Unique identifier for a PA component + example: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46 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/PAComponentRoot' + description: Expected response, returns the default settings of a PA component. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8023,7 +7883,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid account. + description: Invalid PA component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8064,7 +7924,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Account not found. + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8259,37 +8119,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configurations + summary: Get PA component by id tags: - - Configurations + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationSummaryRoot + response-type: PAComponentRoot x-accepts: application/json - /analytics/engines/vault/v3/configurations/{id}: + /analytics/engines/spar/v3/components: get: - description: This endpoint returns details for a Vault configuration as well - as a list of accounts it is used in. - operationId: getVaultConfigurationById + description: This endpoint returns the list of SPAR components in a given SPAR + document. + operationId: getSPARComponents parameters: - - description: Vault configuration id to get the details of - explode: false - in: path - name: id + - description: Document Name + explode: true + in: query + name: document required: true schema: - description: Vault configuration id to get the details of - example: e95ef921-b4d4-4bb7-93ba-60eca8e3247a + description: Document Name + example: SPAR_DOCUMENTS:Factset Default Document type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VaultConfigurationRoot' - description: Expected response, returns details for a Vault configuration. + $ref: '#/components/schemas/ComponentSummaryRoot' + description: Expected response, returns a list of SPAR components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8330,7 +8190,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid vault configuration code. + description: Invalid query parameter provided or Invalid SPAR document name. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8371,7 +8231,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault configuration id not found. + description: SPAR Document not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8566,26 +8426,118 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configuration by id + summary: Get SPAR components tags: - - Configurations + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationRoot + response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/lookups/v3/currencies: + /analytics/engines/spar/v3/components/{id}: get: - description: This endpoint lists all the currencies that can be applied to any - calculation. - operationId: getCurrencies + description: This endpoint returns the default settings of a SPAR component. + operationId: getSPARComponentById + parameters: + - description: Unique identifier for a SPAR component + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for a SPAR component + example: 067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CurrencyRoot' - description: Expected response, returns a list of currencies. + $ref: '#/components/schemas/SPARComponentRoot' + description: Expected response, returns the default settings of a SPAR component. + 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 SPAR component id. + 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: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8780,56 +8732,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get currencies + summary: Get SPAR component by id tags: - - Currencies + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CurrencyRoot + response-type: SPARComponentRoot x-accepts: application/json - /analytics/engines/vault/v3/dates: + /analytics/engines/vault/v3/components: 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 returns the list of Vault components in a given Vault + document. + operationId: getVaultComponents parameters: - - description: Start Date - explode: true - in: query - name: startdate - 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 + - description: Document Name explode: true in: query - name: account + name: document required: true schema: - description: Account + description: Document Name + example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT type: string style: form responses: @@ -8837,9 +8761,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DateParametersSummaryRoot' - description: Expected response, returns the converted dates in yyyymmdd - format. + $ref: '#/components/schemas/ComponentSummaryRoot' + description: Expected response, returns a list of Vault components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8880,7 +8803,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value is provided. + description: Invalid query parameter provided or invalid Vault document + name. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8921,7 +8845,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: vault Document or account not found. + description: Vault Document not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9116,34 +9040,78 @@ paths: available after successful authentication. type: string style: simple - summary: Convert Vault dates to absolute format + summary: Get Vault components tags: - - Dates + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DateParametersSummaryRoot + response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/engines/fi/v3/discount-curves: + /analytics/engines/vault/v3/components/{id}: get: - description: This endpoint lists all the discount curves that can be applied - to a FI calculation. - operationId: getAllFIDiscountCurves + description: This endpoint returns the default settings of a Vault component. + operationId: getVaultComponentById parameters: - - explode: true - in: query - name: currency - required: false + - description: Unique identifier for a vault component + explode: false + in: path + name: id + required: true schema: + description: Unique identifier for a vault component + example: AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D 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/VaultComponentRoot' + description: Expected response, returns the default settings of a Vault + component. + 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 Vault component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9184,7 +9152,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Not found + description: Vault Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9379,37 +9347,39 @@ paths: available after successful authentication. type: string style: simple - summary: Get Discount Curves + summary: Get Vault component by id tags: - - DiscountCurves + - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FIDiscountCurveInfoRoot + response-type: VaultComponentRoot x-accepts: application/json - /analytics/engines/vault/v3/documents/{path}: + /analytics/engines/vault/v3/configurations: get: - description: This endpoint looks up all Vault documents and sub-directories - in a given directory. - operationId: getVaultDocuments + description: This endpoint returns all the Vault configurations saved in the + provided account. + operationId: getVaultConfigurations parameters: - - description: The directory to get the documents in - explode: false - in: path - name: path + - description: Required account query parameter to filter configurations for + a specific account + explode: true + in: query + name: account required: true schema: - description: The directory to get the documents in - example: 'Client:' + description: Required account query parameter to filter configurations for + a specific account + example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Vault documents and directories + $ref: '#/components/schemas/VaultConfigurationSummaryRoot' + description: Expected response, returns a dictionary of Vault configurations. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9450,7 +9420,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + description: Invalid account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9491,7 +9461,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9528,7 +9498,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. @@ -9584,7 +9554,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. @@ -9649,7 +9619,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. @@ -9668,7 +9638,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. @@ -9686,37 +9656,38 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault documents and sub-directories in a directory + summary: Get Vault configurations tags: - - Documents + - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: VaultConfigurationSummaryRoot x-accepts: application/json - /analytics/engines/spar/v3/documents/{path}: + /analytics/engines/pa/v3/commentary/configurations: get: - description: This endpoint looks up all SPAR3 documents and sub-directories - in a given directory. - operationId: getSPAR3Documents + description: This endpoint returns all PA commentary configurations in a given + directory. + operationId: getPACommentaryConfigurations parameters: - - description: The directory to get the documents in - explode: false - in: path + - description: The directory to get the PA commentary configurations + explode: true + in: query name: path required: true schema: - description: The directory to get the documents in + description: The directory to get the PA commentary configurations example: 'Client:' type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of SPAR3 documents and directories + $ref: '#/components/schemas/PACommentaryConfigurationSummaryRoot' + description: Expected response, returns a map of configuration ID to PA + commentary configuration headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9757,48 +9728,7 @@ paths: 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 + description: Invalid path provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9993,28 +9923,28 @@ paths: available after successful authentication. type: string style: simple - summary: Gets SPAR3 documents and sub-directories in a directory + summary: Get PA commentary configurations in a directory tags: - - Documents + - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: PACommentaryConfigurationSummaryRoot x-accepts: application/json - /analytics/engines/pub/v3/documents/{path}: + /analytics/engines/vault/v3/configurations/{id}: get: - description: This endpoint looks up all Publisher documents and sub-directories - in a given directory. - operationId: getPubDocuments + description: This endpoint returns details for a Vault configuration as well + as a list of accounts it is used in. + operationId: getVaultConfigurationById parameters: - - description: The directory to get the documents in + - description: Vault configuration id to get the details of explode: false in: path - name: path + name: id required: true schema: - description: The directory to get the documents in - example: 'Client:' + description: Vault configuration id to get the details of + example: e95ef921-b4d4-4bb7-93ba-60eca8e3247a type: string style: simple responses: @@ -10022,9 +9952,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Publisher documents and - directories + $ref: '#/components/schemas/VaultConfigurationRoot' + description: Expected response, returns details for a Vault configuration. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10065,7 +9994,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + description: Invalid vault configuration code. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10106,7 +10035,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Vault configuration id not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10143,7 +10072,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. @@ -10199,7 +10128,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. @@ -10264,7 +10193,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. @@ -10283,7 +10212,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. @@ -10301,27 +10230,26 @@ paths: available after successful authentication. type: string style: simple - summary: Gets Publisher documents and sub-directories in a directory + summary: Get Vault configuration by id tags: - - Documents + - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: VaultConfigurationRoot x-accepts: application/json - /analytics/engines/fiab/v1/calculations: + /analytics/lookups/v3/currencies: get: - description: This endpoints returns all FIAB calculation requests. - operationId: getCalculationStatusSummaries + description: This endpoint lists all the currencies that can be applied to any + calculation. + operationId: getCurrencies responses: "200": content: application/json: schema: - additionalProperties: - $ref: '#/components/schemas/FIABCalculationStatusSummary' - type: object - description: List of active FIAB calculation requests. + $ref: '#/components/schemas/CurrencyRoot' + description: Expected response, returns a list of currencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10377,7 +10305,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. @@ -10516,66 +10444,85 @@ paths: available after successful authentication. type: string style: simple - summary: Get all FIAB calculation summaries + summary: Get currencies tags: - - FIAB Calculations + - Currencies x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" + response-type: CurrencyRoot x-accepts: application/json - 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: - "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 - 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. + /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 ( Account Name ending with .ACCT or .ACTM ) + explode: true + in: query + name: account + required: true + schema: + description: Account ( Account Name ending with .ACCT or .ACTM ) + example: Client:/Folder1/Folder2/AccountName.ACCT + type: string + style: form + responses: + "200": + 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: Maximum FIAB request limit. + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FIAB 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 FIAB 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: @@ -10597,15 +10544,12 @@ paths: type: string style: simple "400": - description: Invalid POST body. - headers: - Location: - description: URL to check status of the request. - explode: false + content: + application/json: schema: - description: URL to check status of the request. - type: string - style: simple + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid query parameter or value is provided. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -10622,21 +10566,6 @@ 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 @@ -10655,16 +10584,13 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - Location: - description: URL to check status of the request. - explode: false + "404": + content: + application/json: schema: - description: URL to check status of the request. - type: string - style: simple + $ref: '#/components/schemas/ClientErrorResponse' + description: Document or account not found. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -10681,31 +10607,27 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FIAB request limit. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. 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. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. 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. + 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 + "401": + description: Missing or invalid authentication. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -10722,19 +10644,23 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FIAB 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 FIAB request limit. + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FIAB 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 FIAB 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: @@ -10755,17 +10681,9 @@ 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: - 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 @@ -10782,21 +10700,6 @@ 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 @@ -10816,16 +10719,9 @@ paths: 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. + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. 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 @@ -10842,39 +10738,6 @@ 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 - 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. @@ -10886,13 +10749,6 @@ paths: description: Server error. Log the X-DataDirect-Request-Key header to assist 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 @@ -10909,31 +10765,9 @@ 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 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 @@ -10950,80 +10784,67 @@ 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 - summary: Run FIAB calculation + summary: Convert PA dates to absolute format tags: - - FIAB Calculations + - Dates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "202" - x-contentType: application/json + - status-code: "200" + response-type: DateParametersSummaryRoot x-accepts: application/json - /analytics/engines/fiab/v1/calculations/{id}: + /analytics/engines/vault/v3/dates: get: - description: This is the endpoint to check on the progress of a previously requested - calculation. - operationId: getCalculationById + 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 parameters: - - description: from url, provided from the location header in the Run FIAB Calculation - endpoint - explode: false - in: path - name: id + - description: Start Date + explode: true + in: query + name: startdate + required: false + schema: + description: Start Date + type: string + style: form + - description: End Date + explode: true + in: query + name: enddate required: true schema: - description: from url, provided from the location header in the Run FIAB - Calculation endpoint + description: End Date type: string - style: simple + 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: "200": content: application/json: schema: - $ref: '#/components/schemas/FIABCalculationStatus' - description: Expected response, returns status information of the entire - calculation if it is complete. + $ref: '#/components/schemas/DateParametersSummaryRoot' + description: Expected response, returns the converted dates in yyyymmdd + format. 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 @@ -11058,23 +10879,13 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: schema: - $ref: '#/components/schemas/FIABCalculationStatus' - description: Expected response, returns status information of the entire - calculation if it is not complete. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid query parameter or value is provided. 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 @@ -11109,8 +10920,12 @@ paths: schema: type: string style: simple - "400": - description: Invalid identifier provided. + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: vault Document or account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11202,9 +11017,8 @@ paths: schema: type: string style: simple - "404": - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11240,9 +11054,36 @@ 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 + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11279,64 +11120,35 @@ paths: available after successful authentication. type: string style: simple - summary: Get FIAB calculation by id + summary: Convert Vault dates to absolute format tags: - - FIAB Calculations + - Dates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FIABCalculationStatus - - status-code: "202" - response-type: FIABCalculationStatus + response-type: DateParametersSummaryRoot 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 + /analytics/engines/fi/v3/discount-curves: + get: + description: This endpoint lists all the discount curves that can be applied + to a FI calculation. + operationId: getAllFIDiscountCurves parameters: - - description: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control + - explode: true + in: query + name: currency required: false schema: type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FICalculationParametersRoot' - description: Calculation Parameters + style: form responses: - "202": + "200": 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. + $ref: '#/components/schemas/FIDiscountCurveInfoRoot' + description: Expected response, returns a list of FI discount curves. 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 @@ -11353,20 +11165,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 @@ -11385,16 +11183,12 @@ paths: schema: type: string style: simple - "201": + "404": 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. + $ref: '#/components/schemas/ClientErrorResponse' + description: Not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11412,20 +11206,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 @@ -11444,19 +11224,12 @@ 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 + "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 @@ -11470,18 +11243,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: @@ -11502,15 +11280,8 @@ paths: 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11528,20 +11299,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 @@ -11560,8 +11317,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. @@ -11579,22 +11337,35 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. 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. + "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: Number of FI requests remaining till request limit reached. + description: FactSet's request key header. type: string style: simple - "403": - description: User is forbidden with current credentials + 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. @@ -11612,18 +11383,52 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. + summary: Get Discount Curves + tags: + - DiscountCurves + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: FIDiscountCurveInfoRoot + x-accepts: application/json + /analytics/engines/pa/v3/documents/{path}: + get: + description: This endpoint looks up all PA3 documents and sub-directories in + a given directory. + operationId: getPA3Documents + parameters: + - description: The directory to get the documents and sub-directories in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the documents and sub-directories in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $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: 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: @@ -11644,9 +11449,12 @@ 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' + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11664,20 +11472,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 @@ -11696,9 +11490,12 @@ 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' + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11716,20 +11513,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 @@ -11748,16 +11531,8 @@ 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. + "401": + description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11775,22 +11550,8 @@ 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. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11808,50 +11569,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 - 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. + 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. @@ -11887,110 +11624,9 @@ paths: 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: 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 + "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. @@ -12008,27 +11644,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. @@ -12047,7 +11672,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. @@ -12065,27 +11690,28 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel FI calculation by id + summary: Get PA3 documents and sub-directories in a directory tags: - - FICalculations + - Documents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: DocumentDirectoriesRoot x-accepts: application/json + /analytics/engines/vault/v3/documents/{path}: get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + description: This endpoint looks up all Vault documents and sub-directories + in a given directory. + operationId: getVaultDocuments parameters: - - description: from url, provided from the location header in the Create and - Run FI calculation endpoint + - description: The directory to get the documents in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run FI calculation endpoint + description: The directory to get the documents in + example: 'Client:' type: string style: simple responses: @@ -12093,34 +11719,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FICalculationParametersRoot' - description: Expected response, returns the FI calculation parameters. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Vault documents and directories 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 @@ -12160,7 +11761,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12201,7 +11802,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12238,7 +11839,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. @@ -12293,6 +11894,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 @@ -12314,7 +11979,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. @@ -12332,117 +11997,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get FI calculation parameters by id + summary: Get Vault documents and sub-directories in a directory tags: - - FICalculations + - Documents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FICalculationParametersRoot + response-type: DocumentDirectoriesRoot 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 + /analytics/engines/spar/v3/documents/{path}: + 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: id + name: path 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. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + description: The directory to get the documents in + example: 'Client:' 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": + "200": 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. + $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. @@ -12483,10 +12068,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12527,54 +12109,7 @@ paths: 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. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12611,7 +12146,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. @@ -12666,9 +12201,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. @@ -12705,8 +12239,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. @@ -12724,24 +12258,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. @@ -12751,7 +12267,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. @@ -12770,7 +12286,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. @@ -12788,48 +12304,38 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update FI calculation and run it. + summary: Gets SPAR3 documents and sub-directories in a directory tags: - - FICalculations - x-are-multiple-success-responses-different: true + - Documents + 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: "200" + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/fi/v3/calculations/{id}/status: + /analytics/engines/pub/v3/documents/{path}: 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 + description: This endpoint looks up all Publisher documents and sub-directories + in a given directory. + operationId: getPubDocuments parameters: - - description: from url, provided from the location header in the Create and - Run FI calculation endpoint + - description: The directory to get the documents in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run FI calculation endpoint + description: The directory to get the documents in + example: 'Client:' type: string style: simple responses: - "201": + "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. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Publisher documents and + directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12865,26 +12371,13 @@ paths: 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. - 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 + "400": + 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/ClientErrorResponse' + description: Invalid query parameter or value provided + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -12919,15 +12412,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. @@ -12963,16 +12453,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: 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. @@ -13008,8 +12509,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. @@ -13027,8 +12528,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. @@ -13046,20 +12566,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 @@ -13085,7 +12594,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. @@ -13103,70 +12612,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get FI calculation status by id + summary: Gets Publisher documents and sub-directories in a directory tags: - - FICalculations - x-are-multiple-success-responses-different: true + - Documents + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "201" - response-type: ObjectRoot - - status-code: "202" + - status-code: "200" + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/fi/v3/calculations/{id}/result: + /analytics/engines/fiab/v1/calculations: 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 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 Get FI calculation - status by id endpoint - type: string - style: simple + description: This endpoints returns all FIAB calculation requests. + operationId: getCalculationStatusSummaries 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. + additionalProperties: + $ref: '#/components/schemas/FIABCalculationStatusSummary' + type: object + description: List of active FIAB 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 @@ -13201,15 +12668,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' - 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: Invalid identifier provided. + 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. @@ -13245,16 +12724,8 @@ paths: schema: type: string style: simple - "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 + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -13290,8 +12761,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. @@ -13309,8 +12781,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. @@ -13328,27 +12808,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 - "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. @@ -13366,9 +12827,37 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + summary: Get all FIAB calculation summaries + tags: + - FIAB Calculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + x-accepts: application/json + 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: + "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 @@ -13385,41 +12874,19 @@ paths: available after successful authentication. type: string style: simple - summary: Get FI calculation result by id - tags: - - FICalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - 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 - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of SPAR frequencies. - 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: @@ -13440,9 +12907,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "400": + 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 @@ -13459,23 +12933,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: @@ -13496,9 +12966,16 @@ 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: + 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 @@ -13515,28 +12992,31 @@ 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. + "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 - "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 @@ -13553,73 +13033,50 @@ 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-Calculations-Limit: + description: Maximum FIAB request limit. explode: false schema: + description: Maximum FIAB request limit. 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-Calculations-Remaining: + description: Number of FIAB requests remaining till request limit reached. explode: false schema: - description: FactSet's request key header. + description: Number of FIAB requests remaining till request limit + reached. 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-Limit: + description: Number of allowed requests 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 - "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 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": - content: - application/json: - schema: - $ref: '#/components/schemas/FrequencyRoot' - description: Expected response, returns a list of Vault frequencies. + "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 @@ -13636,6 +13093,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 @@ -13654,9 +13126,17 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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 @@ -13673,23 +13153,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: @@ -13710,9 +13186,24 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept 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: + 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 @@ -13729,28 +13220,31 @@ 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. + "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 - "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 @@ -13767,149 +13261,80 @@ 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. - 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-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 - summary: Get Vault frequencies + summary: Run FIAB calculation tags: - - Frequencies + - FIAB Calculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: FrequencyRoot + - status-code: "202" + 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/fiab/v1/calculations/{id}: + get: + description: This is the endpoint to check on the progress of a previously requested + calculation. + operationId: getCalculationById parameters: - - description: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Run FIAB 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 Run FIAB + Calculation endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Optimization Parameters responses: - "202": + "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationInfoRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/FIABCalculationStatus' + description: Expected response, returns status information of the entire + calculation if it is complete. 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. + 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 - "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 @@ -13944,13 +13369,23 @@ paths: schema: type: string style: simple - "400": + "202": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid optimization parameters. + $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 @@ -13985,12 +13420,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + "400": + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14082,47 +13513,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 optimization - endpoint or wait for older requests to finish/expire. + "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. @@ -14158,16 +13551,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. @@ -14204,37 +13590,64 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run NPO optimization + summary: Get FIAB calculation by id tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true + - FIAB Calculations + x-are-multiple-success-responses-different: false x-success-response-types: + - status-code: "200" + response-type: FIABCalculationStatus - status-code: "202" - response-type: CalculationInfoRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json + response-type: FIABCalculationStatus x-accepts: application/json - /analytics/engines/npo/v3/optimizations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted optimization. - operationId: cancelOptimizationById + /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: from url, provided from the location header in the Create and - Run NPO optimization endpoint + - description: Long running deadline in seconds. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. explode: false - in: path - name: id - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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 NPO optimization endpoint type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FICalculationParametersRoot' + description: Calculation Parameters responses: - "204": - description: Expected response, optimization was canceled successfully. + "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 @@ -14251,6 +13664,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 @@ -14269,18 +13696,16 @@ paths: schema: type: string style: simple - "400": + "201": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - text/json: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + $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. @@ -14298,6 +13723,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 @@ -14316,19 +13755,15 @@ paths: schema: type: string style: simple - "404": + "400": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: 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: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14346,6 +13781,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 @@ -14364,8 +13813,15 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -14383,23 +13839,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: @@ -14420,9 +13871,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14440,8 +13890,22 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -14459,62 +13923,42 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel NPO optimization by id - tags: - - NPO 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 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: - "200": - content: - application/json: + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false schema: - $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 - Request header. + 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: Standard HTTP header. Header value based on Accept-Encoding - Request header. + description: Number of FI requests remaining till request limit reached. type: string style: simple - Content-Type: - description: Standard HTTP header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests 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-Remaining: + description: Number of requests left for the time window. 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-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 @@ -14531,6 +13975,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 @@ -14549,12 +14007,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "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. @@ -14572,6 +14027,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 @@ -14590,68 +14059,16 @@ paths: schema: type: string style: simple - "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. - 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. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. 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 + "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. @@ -14669,27 +14086,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 - "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. @@ -14707,89 +14119,51 @@ 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: Get NPO optimization parameters by id + summary: Create and Run FI calculation tags: - - NPO 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: NPOOptimizationParametersRoot + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json 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 + /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 NPO 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 NPO optimization endpoint - type: string - style: simple - - description: Long running deadline in seconds. Example value is set to 10s. - Please update it as per requirement before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + Run FI calculation endpoint 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. + "204": + description: Expected response, calculation was canceled successfully. 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 @@ -14824,13 +14198,12 @@ 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' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14866,12 +14239,13 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Optimization Parameters. + 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. @@ -14907,12 +14281,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14930,30 +14300,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 - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate optimization exists with same parameters. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14989,8 +14337,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. @@ -15008,8 +14357,8 @@ 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. @@ -15027,15 +14376,87 @@ 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: 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: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false + $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 @@ -15045,9 +14466,12 @@ 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' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15083,9 +14507,12 @@ paths: 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. + "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. @@ -15121,16 +14548,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. @@ -15167,45 +14643,73 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update NPO optimization and run it. + summary: Get FI calculation parameters by id tags: - - NPO 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" - response-type: ObjectRoot - x-contentType: application/json + - status-code: "200" + response-type: FICalculationParametersRoot 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 + 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 NPO 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 NPO optimization endpoint + Run FI calculation endpoint + type: string + style: simple + - description: Long running deadline in seconds. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: - "201": + "202": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once optimization is completed, returns JSON. + $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 @@ -15240,26 +14744,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 + "201": + content: + 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/ObjectRoot' + application/x-protobuf: 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 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 @@ -15299,7 +14794,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Calculation Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15340,8 +14838,10 @@ 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 + 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. @@ -15377,8 +14877,15 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -15396,27 +14903,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. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: type: string @@ -15433,9 +14921,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15453,8 +14940,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15472,65 +14959,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get NPO optimization status by id - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "201" - response-type: ObjectRoot - - status-code: "202" - 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 - parameters: - - 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 Get NPO - optimization status by id endpoint - type: string - style: simple - responses: - "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. + 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 + "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 @@ -15565,12 +15015,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "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. @@ -15606,13 +15053,16 @@ paths: schema: type: string style: simple - "404": - 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: Optimization result was already returned, provided id was not - a requested optimization, or the optimization was cancelled + 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. @@ -15630,26 +15080,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 - "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. @@ -15667,8 +15099,48 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + summary: Create or Update FI calculation and run it. + 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}/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 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: + "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. @@ -15704,75 +15176,26 @@ 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. + "202": + 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 - summary: Get NPO optimization result by id - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - 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: false - 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. explode: false @@ -15812,7 +15235,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -15853,7 +15279,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation 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. @@ -15909,7 +15339,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. @@ -15945,73 +15375,9 @@ 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. @@ -16048,101 +15414,70 @@ paths: available after successful authentication. type: string style: simple - summary: Get all calculations + summary: Get FI calculation status by id tags: - - PubCalculations - x-are-multiple-success-responses-different: false + - FICalculations + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "200" - response-type: CalculationsSummaryRoot + - status-code: "201" + response-type: ObjectRoot + - status-code: "202" 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 + /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: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Get FI calculation + status by id 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 Get FI calculation + status by id endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Calculation Parameters responses: "200": content: application/json: 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 - 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 - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + $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 - 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 - "201": - content: - application/pdf: - 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. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -16177,20 +15512,16 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: 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 + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: schema: - description: URL to poll for the resulting calculation - type: string - style: simple + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -16225,12 +15556,16 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid calculation parameters. + 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. @@ -16322,12 +15657,9 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - 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. @@ -16345,27 +15677,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 - "415": - description: Missing/Invalid Content-Type 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. @@ -16383,33 +15696,66 @@ 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. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. + summary: Get FI calculation result by id + tags: + - FICalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + 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 + parameters: + - description: Long running deadline in seconds. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: + "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: @@ -16439,16 +15785,13 @@ 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 + "201": + content: + application/json: schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + $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. @@ -16466,57 +15809,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: Create and Run Pub calculation - tags: - - PubCalculations - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "201" - is-file: true - - status-code: "202" - response-type: CalculationStatusRoot - x-contentType: application/json - x-accepts: application/json - /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. + 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. @@ -16552,12 +15868,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16593,13 +15909,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: There was no request for the calculation identifier provided, - or the request was already canceled for the provided identifier. + 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. @@ -16635,8 +15965,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. @@ -16654,8 +15985,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 optimization + endpoint or wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -16691,6 +16041,13 @@ 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. @@ -16730,62 +16087,37 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Pub calculation by id + summary: Create and Run FPO optimization tags: - - PubCalculations - x-are-multiple-success-responses-different: false + - FPO Optimizer + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "204" + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json x-accepts: application/json - get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + /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 Create and - Run Pub calculation endpoint + 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 Pub calculation endpoint + Run FPO optimization endpoint type: string style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Expected response, returns the Pub calculation parameters. + "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 @@ -16822,9 +16154,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: @@ -16863,11 +16201,18 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found - headers: + 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 @@ -16960,7 +16305,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. @@ -16997,129 +16342,62 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation parameters by id + summary: Cancel FPO optimization by id tags: - - PubCalculations + - FPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: PubCalculationParametersRoot + - status-code: "204" 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 + 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 Pub calculation endpoint + 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 Pub calculation endpoint - type: string - style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + Run FPO optimization endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Calculation Parameters responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + $ref: '#/components/schemas/FPOOptimizationParametersRoot' + description: Expected response, returns the FPO 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-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. + 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 - "201": - content: - application/pdf: - 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. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -17136,20 +16414,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 @@ -17168,20 +16432,13 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. 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 @@ -17198,20 +16455,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 @@ -17230,12 +16473,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + description: Optimization id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17253,20 +16496,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 @@ -17304,20 +16533,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 "403": description: User is forbidden with current credentials headers: @@ -17337,20 +16552,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 @@ -17369,12 +16570,9 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - 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. @@ -17392,44 +16590,8 @@ 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 - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate calculation exists with same parameters. + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17447,18 +16609,84 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false + summary: Get FPO optimization parameters by id + tags: + - FPO Optimizer + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: FPOOptimizationParametersRoot + 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 + 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. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: + "202": + content: + application/json: schema: - description: Maximum FI request limit. + $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-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: Number of FI requests remaining till request limit reached. + 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: @@ -17479,9 +16707,13 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "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. @@ -17499,20 +16731,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 @@ -17531,9 +16749,12 @@ 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: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Optimization Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17551,18 +16772,45 @@ 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-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: @@ -17583,16 +16831,12 @@ 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 + "409": + content: + application/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: Duplicate optimization exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17610,22 +16854,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. @@ -17643,84 +16891,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: "200" - response-type: CalculationStatusRoot - - status-code: "201" - is-file: true - - status-code: "202" - response-type: CalculationStatusRoot - x-contentType: application/json - x-accepts: application/json - /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 + "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 @@ -17755,12 +16966,166 @@ paths: schema: type: string style: simple - "202": - content: + "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. + 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 or Update FPO optimization and run it. + 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 + 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 + 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: + "201": + content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns 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 + "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. @@ -17858,8 +17223,8 @@ 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: 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. @@ -17990,58 +17355,49 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation status by id + summary: Get FPO optimization status by id tags: - - PubCalculations - 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: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot - status-code: "202" - response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/fpo/v3/optimizations/{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 the specified format." - operationId: getCalculationUnitResultById + \ 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 Pub calculation + - 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 Pub - calculation status by id endpoint + description: from url, provided from the location header in the Get FPO + optimization 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 + - description: Standard HTTP header. Value can be gzip, compress, deflate, br, + identity and/or * explode: false - in: path - name: unitId - required: true + in: header + name: Accept + required: false schema: - description: from url, provided from the location header in the Get Pub - calculation status by id endpoint type: string style: simple 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 once calculation is completed, returns result - in the format specified in the Calculation parameters. + $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 @@ -18143,27 +17499,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 + "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: 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. @@ -18199,13 +17541,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. @@ -18280,35 +17636,26 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation result by id + summary: Get FPO optimization result by id tags: - - PubCalculations + - FPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - is-file: true + response-type: ObjectRoot x-accepts: application/json - /analytics/engines/quant/v3/calculations: + /analytics/engines/pa/v3/frequencies: get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations - parameters: - - explode: true - in: query - name: pageNumber - required: false - schema: - default: 1 - format: int32 - type: integer - 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/CalculationsSummaryRoot' - description: List of calculation requests. + $ref: '#/components/schemas/FrequencyRoot' + description: Expected response, returns a list of PA frequencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18344,12 +17691,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 page number. + 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. @@ -18385,12 +17747,129 @@ paths: schema: type: string style: simple - "404": + "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 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/spar/v3/frequencies: + get: + description: This endpoint lists all the frequencies that can be applied to + a SPAR calculation. + operationId: getSPARFrequencies + responses: + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation found. + $ref: '#/components/schemas/FrequencyRoot' + description: Expected response, returns a list of SPAR frequencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18446,7 +17925,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. @@ -18585,50 +18064,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get all calculations + summary: Get SPAR frequencies tags: - - QuantCalculations + - Frequencies x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CalculationsSummaryRoot + response-type: FrequencyRoot 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 - parameters: - - description: Standard HTTP header. Accepts no-store, max-age, max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' + /analytics/engines/vault/v3/frequencies: + get: + description: This endpoint lists all the frequencies that can be applied to + a Vault calculation. + operationId: getVaultFrequencies 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/FrequencyRoot' + description: Expected response, returns a list of Vault frequencies. 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 @@ -18663,17 +18119,27 @@ paths: schema: type: string style: simple - "201": - 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/ObjectRoot' - 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/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. + 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. @@ -18709,16 +18175,8 @@ paths: 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18754,15 +18212,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. @@ -18780,33 +18232,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. @@ -18824,33 +18259,45 @@ 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 - "413": + 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/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Request body too large + $ref: '#/components/schemas/GroupRoot' + description: Expected response, returns a list of PA groups headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18868,6 +18315,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 @@ -18942,9 +18398,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. @@ -18981,8 +18436,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. @@ -19000,24 +18455,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. @@ -19027,7 +18464,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. @@ -19064,38 +18501,26 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run Quant Engine calculation + summary: Get PA groups tags: - - QuantCalculations - x-are-multiple-success-responses-different: true + - Groups + 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 + response-type: GroupRoot x-accepts: application/json - /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 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 calculation endpoint - 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, calculation was canceled successfully. + "200": + content: + application/json: + schema: + $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. @@ -19131,12 +18556,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. @@ -19172,13 +18612,8 @@ paths: schema: type: string style: simple - "404": - content: - application/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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19214,27 +18649,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. @@ -19252,27 +18669,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. @@ -19309,64 +18715,59 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Quant calculation by id + summary: Get PA grouping frequencies tags: - - QuantCalculations + - 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 is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + description: This endpoint returns the list of linked PA templates in given + path. + operationId: getLinkedPATemplates 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 + - description: Get linked PA templates in path. + explode: true + in: query + name: directory + required: false schema: - description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + 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/QuantCalculationParametersRoot' - description: Expected response, returns the Quant Engine calculation parameters. + $ref: '#/components/schemas/LinkedPATemplateSummaryRoot' + description: Expected response, returns a list of templates linked to 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. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: description: FactSet's request key header. @@ -19404,7 +18805,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. @@ -19445,7 +18847,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + description: Document not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19537,9 +18939,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. @@ -19576,63 +19042,42 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation parameters by id + summary: Get linked PA templates tags: - - QuantCalculations + - LinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: QuantCalculationParametersRoot + response-type: LinkedPATemplateSummaryRoot 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 - 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 - name: Cache-Control - required: false - schema: - 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/QuantCalculationParametersRoot' - description: Calculation Parameters + $ref: '#/components/schemas/LinkedPATemplateParametersRoot' + description: Request Parameters + required: true responses: - "202": + "201": 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/LinkedPATemplatePostSummaryRoot' + description: Expected response, created a template linked to a PA3 tile. 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 @@ -19667,16 +19112,13 @@ paths: schema: type: string style: simple - "200": + "400": 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. + $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. @@ -19712,17 +19154,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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19740,33 +19173,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' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19803,14 +19211,7 @@ paths: 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. + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19846,15 +19247,8 @@ paths: 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19890,15 +19284,9 @@ paths: schema: type: string style: simple - "413": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Request body too large + "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. @@ -19916,26 +19304,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 - "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. @@ -19953,8 +19331,8 @@ 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. @@ -19972,15 +19350,59 @@ 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 + summary: Create a linked PA template + tags: + - LinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "201" + response-type: LinkedPATemplatePostSummaryRoot + x-contentType: application/json + 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 + example: "01234567890123456789012345678901" + type: string + style: simple + 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 @@ -19990,9 +19412,13 @@ 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' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20028,9 +19454,12 @@ 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' + description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20066,16 +19495,8 @@ 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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20093,8 +19514,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20112,72 +19533,27 @@ paths: available after successful authentication. type: string style: simple - summary: Create or update Quant Engine calculation and run it. - 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 - 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 - 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 - 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 + "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 @@ -20212,30 +19588,101 @@ paths: schema: type: string style: simple - "202": - content: - application/json: + "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: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed, - should contain X-FactSet-Api-PickUp-Progress header. + 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-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: FactSet's progress header. + description: FactSet's request key 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. + 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. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer + 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: Delete a linked PA template. + tags: + - LinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the linked PA template settings. + operationId: getLinkedPATemplatesById + 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 + example: "01234567890123456789012345678901" + type: string + style: simple + responses: + "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. explode: false @@ -20275,7 +19722,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. @@ -20316,8 +19764,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: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20409,9 +19856,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20429,107 +19875,136 @@ 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 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: + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false schema: - format: binary type: string - application/x-protobuf: + 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: - format: binary + description: FactSet's request key header. type: string - application/octet-stream: + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false schema: - format: binary + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string - description: Expected response once calculation is completed, returns JSON - in the format specified in the Calculation parameters. + 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: - 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. + "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: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + 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 linked PA template by id + tags: + - LinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: LinkedPATemplateRoot + 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 + 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/LinkedPATemplatePostSummaryRoot' + description: Expected response, updated a template linked to a PA3 tile. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -20569,13 +20044,8 @@ 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. + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20616,14 +20086,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: Template or component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20715,9 +20178,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. @@ -20754,84 +20281,104 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation result by id + summary: Update a linked PA template tags: - - QuantCalculations + - LinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - is-file: true + response-type: LinkedPATemplatePostSummaryRoot + x-contentType: application/json 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 + /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: from url, provided from the location header in the Get Quant - calculation status by id endpoint + - description: Long running deadline in seconds. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. explode: false - in: path - name: id - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false schema: - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint - type: string + example: 10 + type: integer style: simple - - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint + - description: Standard HTTP header. Accepts 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/NPOOptimizationParametersRoot' + description: Optimization Parameters responses: - "200": + "202": content: application/json: schema: - format: binary + $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 - application/x-protobuf: + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - format: binary + description: FactSet's request key header. type: string - application/octet-stream: + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false schema: - format: binary + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string - description: Expected response once calculation is completed. - headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + style: simple + 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 + "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 @@ -20871,13 +20418,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: Invalid identifier provided. + description: Invalid optimization parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20918,14 +20459,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: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21017,9 +20551,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. @@ -21056,35 +20673,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation metadata information by id + summary: Create and Run NPO optimization tags: - - QuantCalculations - x-are-multiple-success-responses-different: false + - NPO Optimizer + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "200" - is-file: true + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json x-accepts: application/json - /analytics/engines/spar/v3/calculations: - get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations + /analytics/engines/npo/v3/optimizations/{id}: + delete: + description: This is the endpoint to cancel a previously submitted optimization. + operationId: cancelOptimizationById parameters: - - explode: true - in: query - name: pageNumber - required: false + - 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 - type: integer - style: form + description: from url, provided from the location header in the Create and + Run NPO optimization endpoint + type: string + style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationsSummaryRoot' - description: List of calculation requests. + "204": + description: Expected response, optimization was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21122,10 +20740,16 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21163,10 +20787,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation found. + 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. @@ -21222,7 +20853,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. @@ -21258,8 +20889,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json. + "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. @@ -21277,239 +20909,81 @@ 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 - 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 all calculations + summary: Cancel NPO optimization by id tags: - - SPARCalculations + - NPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: CalculationsSummaryRoot + - status-code: "204" 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 + get: + description: This is the endpoint that returns the optimization parameters passed + for an optimization. + operationId: getOptimizationParameters parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Create and + Run NPO optimization 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 NPO optimization endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' - 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 - 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 "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. + $ref: '#/components/schemas/NPOOptimizationParametersRoot' + description: Expected response, returns the NPO 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. + 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 - "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. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -21549,10 +21023,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. @@ -21593,10 +21064,7 @@ 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: Optimization id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21688,9 +21156,9 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "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. @@ -21708,28 +21176,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. + 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. Example value is set to 10s. + Please update it as per requirement before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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. + 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 - "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 @@ -21764,16 +21293,13 @@ 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 + "201": + content: + application/json: schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + $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. @@ -21791,57 +21317,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: Create and Run SPAR calculation - tags: - - SPARCalculations - 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/spar/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 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 - responses: - "204": - description: Expected response, calculation was canceled successfully. + 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. @@ -21877,12 +21376,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21918,13 +21417,12 @@ paths: schema: type: string style: simple - "404": + "409": content: application/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: Duplicate optimization exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22016,28 +21514,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. + "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. @@ -22055,62 +21534,28 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel SPAR calculation - tags: - - SPARCalculations - 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 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 - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' - description: Expected response, returns the SPAR 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 + "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 @@ -22145,12 +21590,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 identifier provided. + 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. @@ -22168,30 +21617,63 @@ 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 - schema: - type: string - style: simple - "404": + 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' - description: Calculation id not found + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns JSON. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22227,28 +21709,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-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 @@ -22283,115 +21763,13 @@ 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 SPAR calculation parameters by id - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: SPARCalculationParametersRoot - 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. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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/SPARCalculationParametersRoot' - description: Calculation Parameters - responses: - "202": + "400": 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/ClientErrorResponse' + description: Invalid identifier provided. 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 @@ -22426,16 +21804,13 @@ paths: schema: type: string style: simple - "200": + "404": 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. + $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. @@ -22471,17 +21846,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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22499,33 +21865,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' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -22561,15 +21902,9 @@ paths: 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. @@ -22587,34 +21922,84 @@ 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: - type: string + 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: Get NPO optimization status by id + tags: + - NPO Optimizer + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "201" + response-type: ObjectRoot + - status-code: "202" + 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 + parameters: + - 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 Get NPO + optimization status by id endpoint + type: string + style: simple + responses: + "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 - "409": - content: - application/json: + Content-Type: + description: Standard HTTP header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + 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: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate calculation exists with same parameters. - headers: + 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 @@ -22649,27 +22034,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. @@ -22705,9 +22075,13 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type 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. @@ -22743,9 +22117,27 @@ 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. + "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. @@ -22781,16 +22173,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. @@ -22827,70 +22212,36 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update SPAR calculation and run it. + summary: Get NPO optimization result by id tags: - - SPARCalculations - x-are-multiple-success-responses-different: true + - NPO Optimizer + 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 x-accepts: application/json - /analytics/engines/spar/v3/calculations/{id}/status: + /analytics/engines/pa/v3/calculations: 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 endpoints returns all calculation requests. + operationId: getAllCalculations 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 + - explode: true + in: query + name: pageNumber + required: false schema: - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint - type: string - style: simple + default: 1 + format: int32 + type: integer + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response once calculation is completed. + $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 @@ -22925,29 +22276,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 page number. 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 @@ -22982,12 +22317,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23023,13 +22358,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. @@ -23065,8 +22414,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. @@ -23084,8 +22433,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. @@ -23103,27 +22471,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. @@ -23160,80 +22517,77 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation status by id + summary: Get all calculations tags: - - SPARCalculations + - PACalculations 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: CalculationsSummaryRoot x-accepts: application/json - /analytics/engines/spar/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 + 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* Account identifiers\ + \ must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be\ + \ optionally set for every account. \r\n Possible values for holdings mode\ + \ are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management\ + \ System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default\ + \ holdings mode value is B&H. \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 grouping frequency without overriding the group id it will\ + \ not be applied to the default groupings saved to the original component.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component." + operationId: postAndCalculate parameters: - - description: from url, provided from the location header in the Get SPAR calculation - status by id endpoint + - description: Long running deadline in seconds when only one unit is passed + in the POST body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. explode: false - in: path - name: id - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false schema: - description: from url, provided from the location header in the Get SPAR - calculation status by id endpoint - type: string + example: 10 + type: integer style: simple - - description: from url, provided from the location header in the Get SPAR calculation - status by id endpoint + - description: Standard HTTP header. Accepts 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 SPAR - calculation status by id endpoint type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PACalculationParametersRoot' + description: Calculation Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' + $ref: '#/components/schemas/CalculationStatusRoot' 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/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: @@ -23270,15 +22624,17 @@ paths: schema: type: string style: simple - "400": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' + $ref: '#/components/schemas/ObjectRoot' application/x-protobuf: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + $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. @@ -23314,16 +22670,16 @@ paths: schema: type: string style: simple - "404": + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' + $ref: '#/components/schemas/CalculationStatusRoot' 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 + $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. @@ -23359,27 +22715,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. @@ -23415,9 +22759,15 @@ paths: 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' + 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. @@ -23435,8 +22785,26 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + 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. @@ -23454,40 +22822,8 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation result by id - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - x-accepts: application/json - /analytics/engines/axp/v3/strategies/{path}: - get: - description: This endpoint looks up all Axioma Equity strategy documents and - sub-directories in a given directory. - operationId: getAxiomaEquityStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma Equity strategy - documents and directories + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23523,12 +22859,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + "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. @@ -23564,12 +22897,9 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + "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. @@ -23605,8 +22935,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication + 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. @@ -23624,8 +22962,57 @@ 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: 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. @@ -23661,8 +23048,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. @@ -23698,9 +23089,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: 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. @@ -23718,16 +23113,83 @@ 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 + "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. @@ -23746,7 +23208,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. @@ -23764,30 +23226,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma Equity strategy documents and sub-directories in a directory + summary: Cancel PA calculation by id tags: - - StrategyDocuments + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot + - status-code: "204" x-accepts: application/json - /analytics/engines/afi/v3/strategies/{path}: get: - description: This endpoint looks up all Axioma FI strategy documents and sub-directories - in a given directory. - operationId: getAxiomaFIStrategyDocuments + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: from url, provided from the location header in the Create and + Run PA calculation endpoint explode: false in: path - name: path + name: id required: true schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' + description: from url, provided from the location header in the Create and + Run PA calculation endpoint type: string style: simple responses: @@ -23795,10 +23254,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma FI strategy documents - and directories + $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 + 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 @@ -23838,7 +23321,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23879,7 +23362,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23916,7 +23399,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. @@ -23971,8 +23454,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json + "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. @@ -23990,27 +23474,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. Wait till the time specified in Retry-After - header value to make further requests. + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24028,87 +23493,91 @@ 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. - 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 - 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 Axioma FI strategy documents and sub-directories in a directory + summary: Get PA calculation parameters by id tags: - - StrategyDocuments + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: PACalculationParametersRoot x-accepts: application/json - /analytics/engines/bpm/v3/strategies/{path}: - get: - description: This endpoint looks up all Barra strategy documents and sub-directories - in a given directory. - operationId: getBarraStrategyDocuments + 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* Account identifiers\ + \ must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be\ + \ optionally set for every account. \r\n Possible values for holdings mode\ + \ are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management\ + \ System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default\ + \ holdings mode value is B&H.\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 grouping frequency without overriding the group id it will\ + \ not be applied to the default groupings saved to the original component.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component." + operationId: putAndCalculate parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: from url, provided from the location header in the Create and + Run PA calculation endpoint explode: false in: path - name: path + name: id required: true schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Barra strategy documents - and directories + $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 @@ -24143,12 +23612,16 @@ paths: schema: type: string style: simple - "400": + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + $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. @@ -24184,12 +23657,17 @@ paths: schema: type: string style: simple - "404": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + $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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24225,27 +23703,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. @@ -24281,8 +23747,15 @@ 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' + 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. @@ -24318,9 +23791,15 @@ 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. + "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. @@ -24338,35 +23817,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 some time + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24384,40 +23854,8 @@ paths: available after successful authentication. type: string style: simple - summary: Get Barra 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/npo/v3/strategies/{path}: - get: - description: This endpoint looks up all Northfield strategy documents and sub-directories - in a given directory. - operationId: getNorthfieldStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Northfield strategy documents - and directories + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24453,12 +23891,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + "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. @@ -24494,12 +23929,9 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + "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. @@ -24535,8 +23967,16 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication + 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. @@ -24554,8 +23994,8 @@ 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. @@ -24573,27 +24013,72 @@ 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 + 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 - 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 - "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 @@ -24628,37 +24113,30 @@ 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 + "202": + 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. + $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 schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + description: FactSet's progress header. type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. + 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 - "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 @@ -24675,67 +24153,30 @@ 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 Northfield 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/vault/v3/load/{batchId}: - post: - description: This endpoint loads Vault External Attributions. - operationId: vaultAttributionLoader - parameters: - - explode: false - in: path - name: batchId - required: true - schema: - 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": + 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/VaultAttributionLoaderResponseRoot' - description: Expected response, returns a status of operation along with - errors and warnings if found any. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24771,12 +24212,13 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Bad Request + 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. @@ -24868,73 +24310,9 @@ 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. @@ -24971,37 +24349,82 @@ paths: available after successful authentication. type: string style: simple - summary: Vault - External Attribution Loader + summary: Get PA calculation status by id tags: - - Vault Attribution Loader + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultAttributionLoaderResponseRoot - x-contentType: multipart/form-data + response-type: CalculationStatusRoot + - status-code: "202" + response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/vault/v3/calculations: + /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result: get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations + 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: - - explode: true - in: query - name: pageNumber - required: false + - 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: - default: 1 - format: int32 - type: integer - style: form + 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/CalculationsSummaryRoot' - description: List of calculation requests. + $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. + 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 @@ -25041,7 +24464,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25082,7 +24508,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation 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. @@ -25138,44 +24568,7 @@ paths: 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. + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25211,36 +24604,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. - 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. @@ -25277,64 +24643,66 @@ paths: available after successful authentication. type: string style: simple - summary: Get all calculations + summary: Get PA calculation result by id tags: - - VaultCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CalculationsSummaryRoot + response-type: ObjectRoot x-accepts: application/json + /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary: post: - description: "This endpoint runs the Vault 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* Start and and end date must be within the configuration's min and\ - \ max date range" - operationId: postAndCalculate + description: "This endpoint can be used to generate the PA portfolio commentary\ + \ based on a previous successful calculation.\r\n\r\nRemarks:\r\n\r\n*\tThe\ + \ PA component used in the calculation must be an attribution tile.\r\n \ + \ \r\n* The \"Variation in Average Weight\" column must be included along\ + \ with those required\r\n as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary)\r\ + \n in the component for successful commentary generation; otherwise, the\ + \ request will result in an error.\r\n\r\n* PA portfolio commentary generation\ + \ is not supported for multi-port requests.\r\n\r\n* The POST calculation\ + \ must use a single portfolio and a benchmark to generate the commentary.\r\ + \n\r\n* PA portfolio commentary with sub-period analysis will be returned\ + \ only when the frequency\r\n is set to something other than \"single\"\ + \ and the report contains more than one sub-period.\r\n \r\n* Commentary\ + \ customization is optional. Please include a configuration ID in the request\ + \ body when customization is desired. \r\n If the configuration ID is not\ + \ specified, the default commentary will be returned." + operationId: generatePAPortfolioCommentary parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. + - description: Successful calculation id explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false + in: path + name: id + required: true schema: - example: 10 - type: integer + description: Successful calculation id + type: string style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: Unit id associated with the successful calculation id explode: false - in: header - name: Cache-Control - required: false + in: path + name: unitId + required: true schema: + description: Unit id associated with the successful calculation id type: string style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Calculation Parameters + $ref: '#/components/schemas/PACommentaryParametersRoot' + description: Request Parameters responses: - "202": + "201": 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/PACommentaryRoot' + description: Expected response if the commentary generation is completed + in a short span, returns JSON. 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 @@ -25369,17 +24737,20 @@ 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. + $ref: '#/components/schemas/PACommentaryGetStatusRoot' + description: Expected response, contains the poll URL in the Location header. headers: + Location: + description: URL to poll for the resulting commentary + explode: false + schema: + description: URL to poll for the resulting commentary + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -25414,17 +24785,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. @@ -25460,15 +24826,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' - 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: Invalid calculation 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. @@ -25504,15 +24882,9 @@ paths: 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. + "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. @@ -25548,103 +24920,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 - 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. - 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. + "429": + description: Rate limit reached. Wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25689,7 +24966,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. @@ -25726,39 +25003,75 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run Vault calculation + summary: Generate PA portfolio commentary by calculation and unit id. tags: - - VaultCalculations + - 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 + response-type: PACommentaryRoot + - status-code: "202" + response-type: PACommentaryGetStatusRoot x-contentType: application/json x-accepts: application/json - /analytics/engines/vault/v3/calculations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted calculation. - operationId: cancelCalculationById + /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status: + get: + description: "This endpoint allows you to check the progress of a previously\ + \ requested PA portfolio commentary. \r\nIf the commentary generation is complete,\ + \ the location header will provide the URL for the result." + operationId: getPAPortfolioCommentaryStatusById parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: Successful calculation id explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + description: Successful calculation id + type: string + style: simple + - description: Unit id associated with the successful calculation id + explode: false + in: path + name: unitId + required: true + schema: + description: Unit id associated with the successful calculation id type: string style: simple responses: - "204": - description: Expected response, calculation was canceled successfully. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PACommentaryStatusRoot' + description: Expected response once commentary 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 @@ -25793,12 +25106,13 @@ paths: schema: type: string style: simple - "400": + "202": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + $ref: '#/components/schemas/PACommentaryGetStatusRoot' + description: Expected response returned if the commentary generation is + not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25834,13 +25148,12 @@ paths: schema: type: string style: simple - "404": + "400": content: application/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: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25934,7 +25247,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. @@ -25971,27 +25284,39 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Vault calculation by id + summary: Get PA portfolio commentary status by calculation and unit id. tags: - - VaultCalculations - x-are-multiple-success-responses-different: false + - PACalculations + x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: PACommentaryStatusRoot + - status-code: "202" + response-type: PACommentaryGetStatusRoot x-accepts: application/json + /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result: get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + description: "This endpoint retrieves the result of a previously requested portfolio\ + \ commentary. \r\nIf the commentary generation is complete, the commentary\ + \ will be returned in a predefined JSON format." + operationId: getPAPortfolioCommentaryResultById parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: Successful calculation id explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + description: Successful calculation id + type: string + style: simple + - description: Unit id associated with the successful calculation id + explode: false + in: path + name: unitId + required: true + schema: + description: Unit id associated with the successful calculation id type: string style: simple responses: @@ -25999,8 +25324,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Expected response, returns the Vault calculation parameters. + $ref: '#/components/schemas/PACommentaryRoot' + description: Expected response once the commentary generation is completed, + returns JSON. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding @@ -26102,47 +25428,6 @@ paths: 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: @@ -26238,76 +25523,58 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault calculation parameters by id + summary: Get PA Portfolio commentary result by calculation and unit id. tags: - - VaultCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultCalculationParametersRoot + response-type: PACommentaryRoot x-accepts: application/json - put: - description: "This endpoint updates and run the Vault calculation specified\ - \ in the PUT body parameters. This also allows creating new Vault 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 + /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: from url, provided from the location header in the Create and - Run Vault calculation endpoint - explode: false - in: path - name: id - required: true + - description: PA pricing sources name + explode: true + in: query + name: name + required: false schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + default: "" + description: PA pricing sources name type: string - style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline + style: form + - description: PA pricing sources category + explode: true + in: query + name: category required: false schema: - example: 10 - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control + 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: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Calculation Parameters + style: form 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/PAPricingSourceRoot' + description: Expected response, returns a list of PA pricing sources 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 @@ -26324,6 +25591,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 @@ -26342,16 +25618,13 @@ paths: schema: type: string style: simple - "200": + "400": 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. + $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. @@ -26387,17 +25660,12 @@ paths: schema: type: string style: simple - "201": + "404": 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: Pricing sources not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26433,15 +25701,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' - 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: Invalid Calculation 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. @@ -26477,15 +25757,8 @@ paths: 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. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26521,15 +25794,9 @@ paths: 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. + "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. @@ -26547,26 +25814,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. @@ -26584,8 +25860,35 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + 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: false + 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. @@ -26621,9 +25924,12 @@ 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' + description: Invalid page number. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26659,9 +25965,12 @@ 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' + description: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26697,16 +26006,8 @@ 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. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26724,8 +26025,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26743,70 +26044,27 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update Vault calculation and run it. - tags: - - VaultCalculations - 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/vault/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 Vault calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run Vault 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 + "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 @@ -26841,29 +26099,37 @@ paths: schema: type: string style: simple - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: - X-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: FactSet's progress header. + description: FactSet's request key 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. + 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. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer + 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 @@ -26880,30 +26146,71 @@ 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: 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: + "200": content: application/json: 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. @@ -26939,13 +26246,19 @@ paths: schema: type: string style: simple - "404": + "201": content: - application/json: + 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 + 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26981,9 +26294,20 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "202": + content: + application/json: + 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 @@ -27000,8 +26324,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 calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27037,9 +26383,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27057,8 +26402,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27076,82 +26421,31 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault calculation status by id - tags: - - VaultCalculations - 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/vault/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 Vault - 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 Vault - calculation status by id endpoint - type: string - style: simple - - description: from url, provided from the location header in the Get Vault - 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 Vault - 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 + "404": + content: + application/json: + 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 @@ -27186,15 +26480,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 identifier provided. + "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. @@ -27230,16 +26518,9 @@ paths: schema: type: string style: simple - "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 + "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. @@ -27275,7 +26556,203 @@ paths: schema: type: string style: simple - "401": + 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 Pub calculation + tags: + - PubCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "201" + is-file: true + - status-code: "202" + response-type: CalculationStatusRoot + x-contentType: application/json + x-accepts: application/json + /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: 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: 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: @@ -27333,7 +26810,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. @@ -27370,113 +26847,16034 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault calculation result by id + summary: Cancel Pub calculation by id tags: - - VaultCalculations + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: ObjectRoot + - status-code: "204" x-accepts: application/json -components: - requestBodies: - inline_object: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/inline_object' - schemas: - ReturnType: - example: - name: name - id: id - properties: - name: - type: string - id: + 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 - type: object - SPARAccounts: - example: - returnsType: - - name: name - id: id - - name: name - id: id - properties: - returnsType: - description: List of SPAR returnsType - items: - $ref: '#/components/schemas/ReturnType' - type: array - type: object - SPARAccountsRoot: - example: - data: - returnsType: - - name: name + 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. + 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 Pub calculation parameters by id + tags: + - PubCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: PubCalculationParametersRoot + 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 + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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: + "200": + content: + application/json: + 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 + 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/pdf: + 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. + 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 + "202": + content: + application/json: + 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 + 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 + "400": + content: + application/json: + 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 + "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 + "404": + content: + application/json: + 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 + "409": + content: + application/json: + 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-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 or Update Pub calculation and run it. + tags: + - PubCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "201" + is-file: true + - status-code: "202" + response-type: CalculationStatusRoot + x-contentType: application/json + x-accepts: application/json + /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. + 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/CalculationStatusRoot' + description: Expected response returned if the calculation is not yet completed. + 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: + 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 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 + "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 Pub calculation status 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 + 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 + parameters: + - 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 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: + "200": + content: + application/pdf: + schema: + format: binary + type: string + application/vnd.openxmlformats-officedocument.presentationml.presentation: + 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 + 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 + "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": + 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. + 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 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: false + 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. + 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 page number. + 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: No calculation 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 all calculations + tags: + - QuantCalculations + 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 Quant Engine calculation specified in the\ + \ POST body parameters.\r\nIt can take one or more calculation units as input." + operationId: postAndCalculate + parameters: + - description: Standard HTTP header. Accepts no-store, max-age, max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuantCalculationParametersRoot' + 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 + 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 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. + 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 + "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 + 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 + "413": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Request body too large + 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. + 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. + 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 Quant Engine calculation + tags: + - QuantCalculations + 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/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 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 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: + 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: 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 Quant calculation by id + tags: + - QuantCalculations + 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 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 + responses: + "200": + content: + application/json: + schema: + $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 + 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 Quant Engine calculation parameters by id + tags: + - QuantCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: QuantCalculationParametersRoot + 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 + 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 + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuantCalculationParametersRoot' + 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 + 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 + "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 + 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 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. + 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 + "413": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Request body too large + 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. + 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. + 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 or update Quant Engine calculation and run it. + 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 + 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 + 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 + 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 + 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/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 + 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: + 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 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 + "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 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 + 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' + application/octet-stream: + 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' + 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. + 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 Quant Engine calculation result 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/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 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 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: + "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 + 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' + application/octet-stream: + 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' + 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. + 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 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: false + 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. + 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 page number. + 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: No calculation 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 all calculations + tags: + - SPARCalculations + 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 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 + parameters: + - description: Long running deadline in seconds when only one unit is passed + in the POST body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/SPARCalculationParametersRoot' + 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 + 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 + "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 + 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 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. + 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 + "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. + 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. + 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 SPAR calculation + tags: + - SPARCalculations + 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/spar/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 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 + 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: + 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: 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 SPAR calculation + tags: + - SPARCalculations + 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 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 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SPARCalculationParametersRoot' + description: Expected response, returns the SPAR 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 SPAR calculation parameters by id + tags: + - SPARCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: SPARCalculationParametersRoot + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/SPARCalculationParametersRoot' + 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 + 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 + "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 + 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 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. + 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. + 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. + 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 or Update SPAR calculation and run it. + tags: + - SPARCalculations + 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/spar/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 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 + 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 + 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/CalculationStatusRoot' + description: Expected response returned if the calculation is not yet completed. + 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: + 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 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 + "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 SPAR calculation status by id + tags: + - SPARCalculations + 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/spar/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 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 + explode: false + in: path + name: unitId + required: true + schema: + description: from url, provided from the location header in the Get SPAR + 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. + 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' + application/x-protobuf: + 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' + 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. + 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 SPAR calculation result by id + tags: + - SPARCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + x-accepts: application/json + /analytics/engines/axp/v3/strategies/{path}: + get: + description: This endpoint looks up all Axioma Equity strategy documents and + sub-directories in a given directory. + operationId: getAxiomaEquityStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma Equity strategy + 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 + 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 some time + 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 Axioma Equity 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/afi/v3/strategies/{path}: + get: + 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 + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma FI strategy 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 + 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 some time + 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 Axioma FI 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/bpm/v3/strategies/{path}: + get: + description: This endpoint looks up all Barra strategy documents and sub-directories + in a given directory. + operationId: getBarraStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Barra strategy 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 + 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 some time + 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 Barra 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/npo/v3/strategies/{path}: + get: + description: This endpoint looks up all Northfield strategy documents and sub-directories + in a given directory. + operationId: getNorthfieldStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Northfield strategy 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 + 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 some time + 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 Northfield 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/fpo/v3/strategies/{path}: + get: + 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 + explode: false + in: path + name: path + required: true + schema: + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + 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. + 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 + 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 some time + 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 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 + example: Personal:TemplatedPAComponents/ + type: string + style: form + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' + description: Expected response, returns a list templated PA components. + 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 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 + "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 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* Account identifiers must have .ACCT or .ACTM extension\ + \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ + \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ + \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ + \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ + \n* Multi-horizon frequencies are not supported through this endpoint.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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: + application/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. + 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 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 + "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: 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 + "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: Create 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 + x-accepts: application/json + /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: + "204": + description: Expected response, deleted the templated PA component 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: + 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: Component 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: Delete templated PA component + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the templated PA component settings. + operationId: getTemplatedPAComponentById + 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: + "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. + 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 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: Templated PA component 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 templated PA component by id + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: TemplatedPAComponentRoot + 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* Account identifiers must have .ACCT or .ACTM\ + \ extension or BENCH: prefix. Holdings mode can be optionally set for every\ + \ account. \r\n Possible values for holdings mode are B&H (Buy and Hold),\ + \ TBR (Transaction based returns), OMS (Order Management System), \r\n \ + \ VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode\ + \ value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through\ + \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall,\ + \ and totals levels of granularity. However, if no value is passed, the default\ + \ value is 'securities'.\r\n Additionally, while 'groupsall' returns all\ + \ the group levels in the PA component,\r\n setting componentdetail to\ + \ 'groups' only returns the expanded or collapsed group levels within the\ + \ PA component.\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 grouping\ + \ 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 + in: path + name: id + 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/TemplatedPAComponentPostSummaryRoot' + description: Expected response, updated 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: + 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: 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: + 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: Update templated PA component + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json + 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. + example: Personal:UninkedPATemplates/ + 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. + example: Weights + type: string + style: form + responses: + "200": + content: + application/json: + schema: + $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. + 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 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 + "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 unlinked PA templates + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateSummaryRoot + 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* Account identifiers must have .ACCT\ + \ or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set\ + \ for every account. \r\n Possible values for holdings mode are B&H (Buy\ + \ and Hold), TBR (Transaction based returns), OMS (Order Management System),\ + \ \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings\ + \ mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported\ + \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ + \ groupsall, and totals levels of granularity. However, if no value is passed,\ + \ the default value is 'securities'.\r\n Additionally, while 'groupsall'\ + \ returns all the group levels in the PA component,\r\n setting componentdetail\ + \ to 'groups' only returns the expanded or collapsed group levels within the\ + \ PA component.\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 grouping\ + \ 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: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, created a unlinked PA template. + 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 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 + "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: Create 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 + x-accepts: application/json + /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: + "204": + description: Expected response, deleted the unlinked 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: + 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: 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: + 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: Delete unlinked PA template + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the template settings. + operationId: getUnlinkedPATemplatesById + 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: + "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. + 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 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: 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: + 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 unlinked PA template details by id + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateRoot + 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* Account identifiers must have .ACCT or .ACTM extension\ + \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ + \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ + \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ + \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ + \n* Multi-horizon frequencies are not supported through this endpoint.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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 + 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/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, updated the unlinked PA template. + 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 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: 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: + 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: 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": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' + description: Expected response, default unlinked PA template types + 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 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. + 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 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. + 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 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: UnlinkedPATemplateCategoryAndTypeDetailsRoot + x-accepts: application/json + /analytics/engines/vault/v3/load/{batchId}: + post: + description: This endpoint loads Vault External Attributions. + operationId: vaultAttributionLoader + parameters: + - explode: false + in: path + name: batchId + required: true + schema: + 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/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. + 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: Bad Request + 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: Vault - External Attribution Loader + tags: + - Vault Attribution Loader + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: VaultAttributionLoaderResponseRoot + x-contentType: multipart/form-data + x-accepts: application/json + /analytics/engines/vault/v3/calculations: + get: + description: This endpoints returns all calculation requests. + operationId: getAllCalculations + parameters: + - explode: true + in: query + name: pageNumber + required: false + 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. + 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 page number. + 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: No calculation 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 all calculations + tags: + - VaultCalculations + 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 Vault 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* Start and and end date must be within the configuration's min and\ + \ max date range" + operationId: postAndCalculate + parameters: + - description: Long running deadline in seconds when only one unit is passed + in the POST body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/VaultCalculationParametersRoot' + 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 + 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 + "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 + 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 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. + 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 + "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. + 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. + 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 Vault calculation + tags: + - VaultCalculations + 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/vault/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 Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault 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: + 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: 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 Vault calculation by id + tags: + - VaultCalculations + 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 Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/VaultCalculationParametersRoot' + description: Expected response, returns the Vault 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 Vault calculation parameters by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: VaultCalculationParametersRoot + x-accepts: application/json + put: + description: "This endpoint updates and run the Vault calculation specified\ + \ in the PUT body parameters. This also allows creating new Vault 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 Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + - description: Long running deadline in seconds when only one unit is passed + in the PUT body. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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/VaultCalculationParametersRoot' + 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 + 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 + "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 + 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 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. + 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. + 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. + 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 or Update Vault calculation and run it. + tags: + - VaultCalculations + 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/vault/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 Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault 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 + 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/CalculationStatusRoot' + description: Expected response returned if the calculation is not yet completed. + 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: + 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 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 + "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 Vault calculation status by id + tags: + - VaultCalculations + 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/vault/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 Vault + 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 Vault + calculation status by id endpoint + type: string + style: simple + - description: from url, provided from the location header in the Get Vault + 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 Vault + 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. + 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' + application/x-protobuf: + 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' + 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. + 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 Vault calculation result by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + x-accepts: application/json +components: + requestBodies: + inline_object: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/inline_object' + schemas: + ReturnType: + example: + name: name + id: id + properties: + name: + type: string + id: + type: string + type: object + SPARAccounts: + example: + returnsType: + - name: name + id: id + - name: name + id: id + properties: + returnsType: + description: List of SPAR returnsType + items: + $ref: '#/components/schemas/ReturnType' + type: array + type: object + SPARAccountsRoot: + example: + data: + returnsType: + - name: name + id: id + - name: name + id: id + meta: '{}' + properties: + data: + $ref: '#/components/schemas/SPARAccounts' + meta: + type: object + required: + - data + type: object + ErrorSource: + example: + pointer: pointer + parameter: parameter + properties: + pointer: + type: string + parameter: + type: string + type: object + Error: + example: + code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + properties: + id: + type: string + code: + type: string + title: + type: string + detail: + type: string + source: + $ref: '#/components/schemas/ErrorSource' + type: object + ClientErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/Error' + type: array + type: object + AccountDirectories: + description: List of the accounts and directories. + 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: + example: + data: + directories: + - directories + - directories + accounts: + - accounts + - accounts + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AccountDirectories' + meta: + type: object + required: + - data + type: object + AFIOptimizerStrategyOverrides: + example: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + properties: + objective: + description: Objective + type: string + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost + type: string + type: object + AFIOptimizerStrategy: + example: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + properties: + overrides: + $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + OptimizerAccountOverrides: + example: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + portfolio: + description: Portfolio + type: string + benchmark: + description: Benchmark + type: string + riskModelId: + description: Risk model + type: string + currency: + description: Currency + type: string + type: object + OptimizerAccount: + example: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + id: + description: Account path + type: string + overrides: + $ref: '#/components/schemas/OptimizerAccountOverrides' + type: object + Optimization: + example: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + properties: + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow + type: string + type: object + OptimizerTradesList: + example: + includeCash: true + identifierType: Asset + properties: + identifierType: + description: Identifier type + enum: + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User + type: string + includeCash: + description: Include cash + type: boolean + type: object + OptimizerOptimalHoldings: + example: + includeCash: true + excludeZero: true + identifierType: Asset + properties: + identifierType: + description: Identifier type + enum: + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User + type: string + includeCash: + description: Include cash + type: boolean + excludeZero: + description: Exclude zero + type: boolean + type: object + OptimalPortfolio: + example: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + properties: + acctName: + description: Account path + type: string + excludeZero: + description: Exclude zero + type: boolean + archiveDate: + description: Archive date + type: string + ifAcctExists: + description: Archive action if account exists + enum: + - abort + - overwrite + - appendDate + type: string + ifOfdbDateExists: + description: Action if ofdb date exists + enum: + - abort + - replaceDate + - appendSecurities + type: string + type: object + OptimizerStats: + type: object + OptimizerOutputTypes: + example: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + properties: + trades: + $ref: '#/components/schemas/OptimizerTradesList' + optimal: + $ref: '#/components/schemas/OptimizerOptimalHoldings' + account: + $ref: '#/components/schemas/OptimalPortfolio' + stats: + type: object + type: object + AFIOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/AFIOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + OptimizerCalculationMeta: + type: object + AFIOptimizationParametersRoot: + example: + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AFIOptimizationParameters' + meta: + type: object + type: object + CalculationInfo: + properties: + calculationId: + description: Calculation identifier + type: string + type: object + CalculationInfoRoot: + properties: + data: + $ref: '#/components/schemas/CalculationInfo' + meta: + type: object + required: + - data + type: object + ObjectRoot: + example: + data: '{}' + meta: '{}' + properties: + data: + type: object + meta: + type: object + required: + - data + type: object + AxiomaEquityOptimizerStrategyOverrides: + example: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + properties: + objective: + description: Objective + type: string + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost + type: string + type: object + AxiomaEquityOptimizerStrategy: + example: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + properties: + overrides: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + AxiomaEquityOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + AxiomaEquityOptimizationParametersRoot: + example: + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' + meta: + type: object + type: object + SPARIdentifier: + 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: Account or benchmark return type. + type: string + prefix: + description: Account or benchmark prefix. + type: string + required: + - id + type: object + SPARBenchmark: + 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: + 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: + example: + item2: Disable + item1: item1 + properties: + item1: + type: string + item2: + enum: + - Disable + - Enable + type: string + type: object + BPMOptimizerStrategyAlphaOverride: + example: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + properties: + formula: + type: string + returnType: + enum: + - Excess + - Total + - Active + - Residual + - Exceptional + type: string + returnMultiplier: + type: string + type: object + BPMOptimizerStrategyOverrides: + example: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + properties: + constraints: + description: List of constraints + items: + $ref: '#/components/schemas/ConstraintAction' + type: array + alpha: + $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' + tax: + description: "Tax\r\nCan be set to \"\" for local" + type: string + transactionCost: + description: "Transaction cost\r\nCan be set to \"\" for local" + type: string + type: object + BPMOptimizerStrategy: + example: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + properties: + overrides: + $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + BPMOptimization: + example: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + properties: + market: + description: Optimization market + type: string + investAllCash: + description: Optimization invest all cash + type: boolean + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow + type: string + type: object + BPMOptimizationParameters: + example: + optimization: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/BPMOptimizerStrategy' + optimization: + $ref: '#/components/schemas/BPMOptimization' + account: + $ref: '#/components/schemas/OptimizerAccount' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + BPMOptimizationParametersRoot: + example: + data: + optimization: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/BPMOptimizationParameters' + meta: + type: object + type: object + ColumnSummary: + description: Column settings (name, directory, category) + example: + name: name + category: category + directory: directory + properties: + name: + description: Column Name + type: string + directory: + description: Column Directory + type: string + category: + description: Column Category + type: string + type: object + ColumnSummaryRoot: + example: + data: + key: + name: name + category: category + directory: directory + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ColumnSummary' + type: object + meta: + type: object + required: + - data + type: object + Column: + example: + defaultstatisticsids: + - defaultstatisticsids + - defaultstatisticsids + name: name + category: category + directory: directory + properties: + defaultstatisticsids: + description: Column statistic Id + items: + type: string + type: array + name: + description: Column Name + type: string + directory: + description: Column Directory + type: string + category: + description: Column Category + type: string + type: object + ColumnRoot: + example: + data: + defaultstatisticsids: + - defaultstatisticsids + - defaultstatisticsids + name: name + category: category + directory: directory + meta: '{}' + properties: + data: + $ref: '#/components/schemas/Column' + meta: + type: object + required: + - data + type: object + ColumnStatistic: + example: + name: name + properties: + name: + description: Column Statistic Name + type: string + type: object + ColumnStatisticRoot: + example: + data: + key: + name: name + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ColumnStatistic' + type: object + meta: + type: object + required: + - data + type: object + ComponentSummary: + example: + name: name + category: category + properties: + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + ComponentSummaryRoot: + example: + data: + key: + name: name + category: category + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ComponentSummary' + type: object + meta: + type: object + required: + - data + type: object + PAIdentifier: + example: + id: id + holdingsmode: holdingsmode + properties: + id: + description: User's FactSet account path OR benchmark. + type: string + holdingsmode: + description: Holdings Mode can be B&H, TBR, OMS , EXT or VLT. + type: string + required: + - id + type: object + PADateParameters: + description: The date parameters for PA calculation. + example: + enddate: enddate + startdate: startdate + frequency: frequency + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency + type: object + PAComponent: + example: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + properties: + id: + description: Component identifier. + type: string + accounts: + description: List of accounts saved in the PA document. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks saved in the PA document. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + currencyisocode: + type: string + dates: + $ref: '#/components/schemas/PADateParameters' + snapshot: + description: Is the component type snapshot or subperiod. + type: boolean + path: + description: The path to the document + type: string + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + PAComponentRoot: + example: + data: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + meta: '{}' + properties: + data: + $ref: '#/components/schemas/PAComponent' + meta: + type: object + required: + - data + type: object + SPARComponent: + example: + path: path + name: name + id: id + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmarks: + prefix: prefix + returntype: returntype + id: id + currencyIsoCode: currencyIsoCode + category: category + properties: + id: + description: Component identifier. + type: string + accounts: + description: List of accounts in SPAR document. + items: + $ref: '#/components/schemas/SPARIdentifier' + type: array + benchmarks: + $ref: '#/components/schemas/SPARIdentifier' + currencyIsoCode: + description: CurrencyCode in SPAR document. + type: string + path: + description: The path to the document + type: string + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + SPARComponentRoot: + example: + data: + path: path + name: name + id: id + accounts: + - prefix: prefix + returntype: returntype id: id - - name: name + - prefix: prefix + returntype: returntype + id: id + benchmarks: + prefix: prefix + returntype: returntype + id: id + currencyIsoCode: currencyIsoCode + category: category + properties: + data: + $ref: '#/components/schemas/SPARComponent' + type: object + VaultIdentifier: + description: The account/benchmark parameter for Vault calculation. + example: + id: id + properties: + id: + description: User's FactSet account path OR benchmark. + type: string + required: + - id + type: object + VaultDateParameters: + description: The date parameters for Vault calculation + example: + enddate: enddate + startdate: startdate + frequency: frequency + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency + type: object + VaultComponent: + example: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: + id: id + snapshot: true + properties: + id: + description: Vault component identifier + type: string + account: + $ref: '#/components/schemas/VaultIdentifier' + benchmark: + $ref: '#/components/schemas/VaultIdentifier' + currencyisocode: + description: Currency iso code saved in the document + type: string + dates: + $ref: '#/components/schemas/VaultDateParameters' + snapshot: + description: Snapshot + type: boolean + path: + description: The path to the document + type: string + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + VaultComponentRoot: + example: + data: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: id: id + snapshot: true + meta: '{}' + properties: + data: + $ref: '#/components/schemas/VaultComponent' + meta: + type: object + required: + - data + type: object + VaultConfigurationSummary: + example: + name: name + properties: + name: + description: Configuration name. + type: string + type: object + VaultConfigurationSummaryRoot: + example: + data: + key: + name: name + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/VaultConfigurationSummary' + type: object + meta: + type: object + required: + - data + type: object + PACommentaryConfigurationSummary: + example: + name: name + directory: directory + properties: + name: + description: PA commentary configuration name + type: string + directory: + description: PA Commentary configuration directory + type: string + type: object + PACommentaryConfigurationSummaryRoot: + example: + data: + key: + name: name + directory: directory + meta: '{}' + properties: + data: + additionalProperties: + $ref: '#/components/schemas/PACommentaryConfigurationSummary' + type: object + meta: + type: object + required: + - data + type: object + ConfigurationAccount: + example: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + properties: + benchmarkCode: + description: Benchmark code. + type: string + benchmarkName: + description: Benchmark name. + type: string + maxEndDate: + description: Maximum end date. + type: string + minStartDate: + description: Minimum start date. + type: string + lockingDate: + description: Locking date. + type: string + name: + description: Account name. + type: string + type: object + VaultConfiguration: + example: + name: name + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + properties: + name: + description: Configuration name. + type: string + accounts: + additionalProperties: + $ref: '#/components/schemas/ConfigurationAccount' + type: object + type: object + VaultConfigurationRoot: + example: + data: + name: name + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName meta: '{}' properties: data: - $ref: '#/components/schemas/SPARAccounts' + $ref: '#/components/schemas/VaultConfiguration' meta: type: object required: - data type: object - ErrorSource: + Currency: + description: Details of the currency. example: - pointer: pointer - parameter: parameter + name: name properties: - pointer: - type: string - parameter: + name: + description: Name of currency. type: string type: object - Error: + CurrencyRoot: example: - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title + data: + key: + name: name + meta: '{}' properties: - id: + data: + additionalProperties: + $ref: '#/components/schemas/Currency' + type: object + meta: + type: object + required: + - data + type: object + DateParametersSummary: + example: + enddate: enddate + startdate: startdate + properties: + startdate: + description: Start date in YYYYMMDD format. type: string - code: + enddate: + description: End date in YYYYMMDD format. type: string - title: + type: object + DateParametersSummaryRoot: + example: + data: + enddate: enddate + startdate: startdate + meta: '{}' + properties: + data: + $ref: '#/components/schemas/DateParametersSummary' + meta: + type: object + required: + - data + type: object + FIDiscountCurveInfo: + example: + name: name + currency: currency + category: category + properties: + category: type: string - detail: + name: + type: string + currency: type: string - source: - $ref: '#/components/schemas/ErrorSource' type: object - ClientErrorResponse: + FIDiscountCurveInfoRoot: + example: + data: + key: + name: name + currency: currency + category: category + meta: '{}' properties: - errors: - items: - $ref: '#/components/schemas/Error' - type: array + data: + additionalProperties: + $ref: '#/components/schemas/FIDiscountCurveInfo' + type: object + meta: + type: object + required: + - data type: object - AccountDirectories: - description: List of the accounts and directories. + DocumentDirectories: example: + documents: + - documents + - documents directories: - directories - directories - accounts: - - accounts - - accounts properties: - accounts: - description: List of account and composite files. + documents: + description: List of documents items: type: string type: array @@ -27486,1079 +42884,1366 @@ components: type: string type: array type: object - AccountDirectoriesRoot: + DocumentDirectoriesRoot: example: data: + documents: + - documents + - documents directories: - directories - directories - accounts: - - accounts - - accounts meta: '{}' properties: data: - $ref: '#/components/schemas/AccountDirectories' + $ref: '#/components/schemas/DocumentDirectories' meta: type: object required: - data type: object - AFIOptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - properties: - objective: - description: Objective - type: string - tax: - description: Tax - type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string - description: List of constraints - type: object - alpha: - description: Alpha - type: string - transactionCost: - description: Transaction cost - type: string - type: object - AFIOptimizerStrategy: + FIABIdentifier: example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective id: id properties: - overrides: - $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' id: - description: OptimizerStrategy document path + description: User's FactSet account path. type: string required: - id type: object - OptimizerAccountOverrides: + FIABDateParameters: + description: The date parameters for FIAB calculations. example: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + enddate: enddate + startdate: startdate properties: - portfolio: - description: Portfolio - type: string - benchmark: - description: Benchmark - type: string - riskModelId: - description: Risk model - type: string - currency: - description: Currency + startdate: + description: Calculation's start date. type: string - type: object - OptimizerAccount: - example: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - id: - description: Account path + enddate: + description: Calculation's end date. type: string - overrides: - $ref: '#/components/schemas/OptimizerAccountOverrides' + required: + - enddate + - startdate type: object - Optimization: + FIABCalculationParameters: example: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate + fiabdocument: fiabdocument + msl: msl + dates: + enddate: enddate + startdate: startdate + fisettingsdocument: fisettingsdocument + account: + id: id properties: - riskModelDate: - description: Risk model date - type: string - backtestDate: - description: Backtest date + fiabdocument: + description: "FiabDocument (optional) - FIAB document to use as a template.\ + \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" type: string - cashflow: - description: Cash flow + account: + $ref: '#/components/schemas/FIABIdentifier' + dates: + $ref: '#/components/schemas/FIABDateParameters' + msl: + description: Master FISecurity List. Analytics results will be written to + the selected MSL. Expects a GUI-style path (Client:/foo/bar) type: string - type: object - OptimizerTradesList: - example: - includeCash: true - identifierType: Asset - properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User + fisettingsdocument: + description: "FISettingsDocument (optional) - The given @FIS document will\ + \ be used to\r\nconfigure analytics assumptions and settings. Expects\ + \ a GUI-style path (Client:/foo/bar)" type: string - includeCash: - description: Include cash - type: boolean + required: + - account + - dates type: object - OptimizerOptimalHoldings: - example: - includeCash: true - excludeZero: true - identifierType: Asset + FIABCalculationStatusSummary: properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User + requesttime: + description: Request time of calculation. + format: date-time + type: string + lastpolltime: + description: Last poll time of calculation. + format: date-time type: string - includeCash: - description: Include cash - type: boolean - excludeZero: - description: Exclude zero - type: boolean type: object - OptimalPortfolio: + EventSummary: example: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName + submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type properties: - acctName: - description: Account path - type: string - excludeZero: - description: Exclude zero - type: boolean - archiveDate: - description: Archive date + message: + description: Event's message type: string - ifAcctExists: - description: Archive action if account exists - enum: - - abort - - overwrite - - appendDate + submissiondatetime: + description: Event's submission time + format: date-time type: string - ifOfdbDateExists: - description: Action if ofdb date exists - enum: - - abort - - replaceDate - - appendSecurities + type: + description: Event's type type: string type: object - OptimizerStats: - type: object - OptimizerOutputTypes: + FIABCalculationStatus: example: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName + completiondatetime: 2000-01-23T04:56:07.000+00:00 + batchevents: + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + progress: 0 + id: id + status: Pending + startdatetime: 2000-01-23T04:56:07.000+00:00 properties: - trades: - $ref: '#/components/schemas/OptimizerTradesList' - optimal: - $ref: '#/components/schemas/OptimizerOptimalHoldings' - account: - $ref: '#/components/schemas/OptimalPortfolio' - stats: - type: object + id: + description: Calculation's identifier + type: string + status: + description: Calculation's status + enum: + - Pending + - InProgress + - Done + - Paused + - Cancelled + - Error + type: string + startdatetime: + description: Start time + format: date-time + type: string + completiondatetime: + description: Completion time + format: date-time + type: string + progress: + description: Calculation's progress + format: int32 + type: integer + batchevents: + description: List of batch events + items: + $ref: '#/components/schemas/EventSummary' + type: array type: object - AFIOptimizationParameters: + FIReferencePrepay: example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + prepayName: prepayName properties: - strategy: - $ref: '#/components/schemas/AFIOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - OptimizerCalculationMeta: + prepayName: + description: Reference Prepay Name + type: string type: object - AFIOptimizationParametersRoot: + FIReferenceSecurity: example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + properties: + securityType: + description: Reference Security Type + type: string + securityName: + description: Reference Security Name + type: string + calcFromMethod: + description: "Reference Calculation Method.\r\nMethods : Active Spread,\ + \ Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield\ + \ To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield\ + \ To Worst Call, Discount Yield, Discount Margin, Implied Volatility,\ + \ Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + type: string + calcFromValue: + description: Reference CalcFromValue + format: double + type: number + prepay: + $ref: '#/components/schemas/FIReferencePrepay' + settlement: + description: Reference Settlement Date + type: string + type: object + FIBankLoans: + example: + ignoreSinkingFund: true properties: - data: - $ref: '#/components/schemas/AFIOptimizationParameters' - meta: - type: object + ignoreSinkingFund: + description: Ignore Sinking Fund + type: boolean type: object - CalculationInfo: + FIMunicipalBonds: + example: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true properties: - calculationId: - description: Calculation identifier - type: string + ignoreSinkingFund: + description: Ignore Sinking Fund Schedule + type: boolean + useAnticipatedSinkSchedule: + description: Anticipate Sink Schedule + type: boolean type: object - CalculationInfoRoot: + FILoss: + example: + lossName: lossName properties: - data: - $ref: '#/components/schemas/CalculationInfo' - meta: - type: object - required: - - data + lossName: + description: Loss Name + type: string type: object - ObjectRoot: + FIPrepay: example: - data: '{}' - meta: '{}' + prepayName: prepayName properties: - data: - type: object - meta: - type: object - required: - - data + prepayName: + description: Prepay Name + type: string type: object - AxiomaEquityOptimizerStrategyOverrides: + FIServicerAdvancesForSecurities: example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All properties: - objective: - description: Objective + principal: + description: Principal + format: double + type: number + interest: + description: Interest + format: double + type: number + advanceType: + description: Advance Type + enum: + - Advances All + - Advances All But Newly Liqdtd + - Does Not Advance + - Principal Only + - Interest Only type: string - tax: - description: Tax + type: object + FIPrepayLockout: + example: + pointsAbove: ANY + ymAbove: ANY + properties: + pointsAbove: + description: Points Above + enum: + - ANY + - NO_LOCKOUT + - NUMERIC type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string - description: List of constraints - type: object - alpha: - description: Alpha + ymAbove: + description: Ym Above + enum: + - ANY + - NO_LOCKOUT + - NUMERIC type: string - transactionCost: - description: Transaction cost + type: object + FICashflows: + example: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + properties: + optionalRedemptionCallWhenUnits: + description: OptionalRedemptionCallWhenUnits + enum: + - Manual + - Never + - ASAP + - Date + - Deal Closing + - Settle Date type: string + optionalRedemptionCallWhen: + description: OptionalRedemptionCallWhen + format: int32 + type: integer + recoveryLag: + description: RecoveryLag + format: int32 + type: integer type: object - AxiomaEquityOptimizerStrategy: + FIBalloonExtension: example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 properties: - overrides: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path + months: + description: Months + format: int32 + type: integer + percentage: + description: Percentage + format: double + type: number + amortizationType: + description: Amortization Type + enum: + - Loan_Amort_None + - Loan_Amort_Regular + - Loan_Amort_Default type: string - required: - - id + units: + description: Units + type: string + couponStepup: + description: Coupon Stepup + format: double + type: number type: object - AxiomaEquityOptimizationParameters: + FIStructuredProductsForSecurities: example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + properties: + servicerAdvances: + $ref: '#/components/schemas/FIServicerAdvancesForSecurities' + ignoreFinancialGuarantee: + description: Ignore Financial Guarantee + type: string + cleanUpCallMethod: + description: Cleanup Call Method + type: boolean + doOPTRedeem: + description: Do OPT Redeem + type: string + prepayLockout: + $ref: '#/components/schemas/FIPrepayLockout' + cashflows: + $ref: '#/components/schemas/FICashflows' + balloonExtension: + $ref: '#/components/schemas/FIBalloonExtension' + type: object + FIAttributionForSecurities: + example: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 properties: - strategy: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy + startPrice: + description: Start Price + format: double + type: number + endPrice: + description: End Price + format: double + type: number + startSpread: + description: Start Spread + format: double + type: number + endSpread: + description: End Spread + format: double + type: number + pricingMethod: + description: Pricing Method + enum: + - Inputted Price + - Pricing Matrix + - Actual Spread + - OAS + type: string type: object - AxiomaEquityOptimizationParametersRoot: + FIConvertibleSettings: example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 properties: - data: - $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' - meta: - type: object + equityPrice: + description: Equity Price + format: double + type: number + equityIndexVolatility: + description: Equity Index Volatility + format: double + type: number + equityDividendYield: + description: Equity Dividend Yield + format: double + type: number + volatilityCapMethod: + description: Volatility CapMethod + enum: + - noCap + - specifiedRate + - multiplier + type: string + volatilityCapMethodValue: + description: Volatility CapMethod Value - (Required only when volatilityCapMethod + is specifiedRate or multiplier) + format: double + type: number + equityExchangeRate: + description: Equity Exchange Rate + format: double + type: number type: object - SPARIdentifier: - description: The account/benchmark parameter for SPAR calculation. + FISecurity: example: - prefix: prefix - returntype: returntype - id: id + callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 properties: - id: - description: User's FactSet account OR benchmark id. + settlement: + description: Settlement date + type: string + callMethod: + description: Call Method + enum: + - No Call + - Intrinsic Value + - First Call + - First Par + type: string + referenceSecurity: + $ref: '#/components/schemas/FIReferenceSecurity' + bankLoans: + $ref: '#/components/schemas/FIBankLoans' + municipalBonds: + $ref: '#/components/schemas/FIMunicipalBonds' + loss: + $ref: '#/components/schemas/FILoss' + prepay: + $ref: '#/components/schemas/FIPrepay' + matrixSpreadAdjustment: + description: Matrix Spread Adjustment + format: double + type: number + matrixMultiplier: + description: Matrix Multiplier + format: double + type: number + structuredProducts: + $ref: '#/components/schemas/FIStructuredProductsForSecurities' + attribution: + $ref: '#/components/schemas/FIAttributionForSecurities' + convertible: + $ref: '#/components/schemas/FIConvertibleSettings' + calcFromMethod: + description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ + \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ + \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" + type: string + calcFromValue: + description: Calculation from value + format: double + type: number + face: + default: 1 + description: Face + format: double + type: number + faceType: + default: Current + description: Face type + enum: + - Current + - Original type: string - returntype: - description: Account or benchmark return type. + symbol: + description: Symbol type: string - prefix: - description: Account or benchmark prefix. + discountCurve: + description: Discount curve type: string required: - - id - type: object - SPARBenchmark: - 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 + - calcFromValue + - symbol type: object - SPARBenchmarkRoot: + FIMunicipalBondsForJobSettings: example: - data: - identifiers: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - name: name - id: id - meta: '{}' + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true properties: - data: - $ref: '#/components/schemas/SPARBenchmark' - meta: - type: object - required: - - data + allowSinkForInstallmentPayment: + description: Allow Sink For Installment Payment + type: boolean + ignoreSinkingFund: + description: Ignore Sinking Fund Schedule + type: boolean + useAnticipatedSinkSchedule: + description: Anticipate Sink Schedule + type: boolean type: object - ConstraintAction: + FIMarketEnvironment: example: - item2: Disable - item1: item1 + ratePath: FLAT & FORWARD properties: - item1: - type: string - item2: + ratePath: + default: FLAT & FORWARD + description: Rate Path enum: - - Disable - - Enable + - FLAT + - FORWARD + - FLAT & FORWARD type: string type: object - BPMOptimizerStrategyAlphaOverride: + FIServicerAdvances: example: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + advanceType: Advances All properties: - formula: - type: string - returnType: + advanceType: + description: Advance Type enum: - - Excess - - Total - - Active - - Residual - - Exceptional - type: string - returnMultiplier: + - Advances All + - Advances All But Newly Liqdtd + - Does Not Advance + - Principal Only + - Interest Only type: string type: object - BPMOptimizerStrategyOverrides: + FIStructuredProductsForJobSettings: example: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 properties: - constraints: - description: List of constraints - items: - $ref: '#/components/schemas/ConstraintAction' - type: array - alpha: - $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' - tax: - description: "Tax\r\nCan be set to \"\" for local" + servicerAdvances: + $ref: '#/components/schemas/FIServicerAdvances' + ignoreFinancialGuarantee: + description: Ignore Financial Guarantee type: string - transactionCost: - description: "Transaction cost\r\nCan be set to \"\" for local" + cleanUpCallMethod: + description: Cleanup Call Method + type: boolean + doOPTRedeem: + description: Do OPT Redeem type: string + prepayLockout: + $ref: '#/components/schemas/FIPrepayLockout' + cashflows: + $ref: '#/components/schemas/FICashflows' + balloonExtension: + $ref: '#/components/schemas/FIBalloonExtension' type: object - BPMOptimizerStrategy: + FIAttributionForJobSettings: example: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id + endDate: endDate + startDate: startDate properties: - overrides: - $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path + startDate: + description: Start Date + type: string + endDate: + description: End Date type: string - required: - - id type: object - BPMOptimization: + FIJobSettings: example: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement properties: - market: - description: Optimization market + asOfDate: + description: As of date type: string - investAllCash: - description: Optimization invest all cash - type: boolean - riskModelDate: - description: Risk model date + partialDurationMonths: + description: Partial duration months + items: + format: int32 + type: integer + type: array + callMethod: + description: Call Method + enum: + - No Call + - Intrinsic Value + - First Call + - First Par type: string - backtestDate: - description: Backtest date + settlement: + description: Settlement Date type: string - cashflow: - description: Cash flow + calcFromMethod: + description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ + \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ + \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" type: string + bankLoans: + $ref: '#/components/schemas/FIBankLoans' + municipalBonds: + $ref: '#/components/schemas/FIMunicipalBondsForJobSettings' + marketEnvironment: + $ref: '#/components/schemas/FIMarketEnvironment' + structuredProducts: + $ref: '#/components/schemas/FIStructuredProductsForJobSettings' + attribution: + $ref: '#/components/schemas/FIAttributionForJobSettings' + required: + - asOfDate type: object - BPMOptimizationParameters: + FICalculationParameters: example: - optimization: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 properties: - strategy: - $ref: '#/components/schemas/BPMOptimizerStrategy' - optimization: - $ref: '#/components/schemas/BPMOptimization' - account: - $ref: '#/components/schemas/OptimizerAccount' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' + securities: + description: List of securities + items: + $ref: '#/components/schemas/FISecurity' + type: array + calculations: + description: List of calculations + items: + type: string + type: array + jobSettings: + $ref: '#/components/schemas/FIJobSettings' required: - - outputTypes - - strategy + - calculations + - jobSettings + - securities type: object - BPMOptimizationParametersRoot: + CalculationMeta: example: - data: - optimization: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: + contentorganization: + default: SimplifiedRow + deprecated: true + enum: + - None + - Row + - Column + - SimplifiedRow + type: string + stachContentOrganization: + default: SimplifiedRow + enum: + - None + - Row + - Column + - SimplifiedRow + type: string + contenttype: + default: Json + deprecated: true + enum: + - Json + - Binary + type: string + format: + default: JsonStach + enum: + - JsonStach + - Table + - Tableau + - BinaryStach + - Bison + - Binary + - Pdf + - Pptx + - Feather + type: string + type: object + FICalculationParametersRoot: + example: data: - $ref: '#/components/schemas/BPMOptimizationParameters' + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate + marketEnvironment: + ratePath: FLAT & FORWARD + asOfDate: asOfDate + bankLoans: + ignoreSinkingFund: true + partialDurationMonths: + - 9 + - 9 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.025004791520295 + convertible: + volatilityCapMethodValue: 1.1730742509559433 + equityPrice: 1.4894159098541704 + volatilityCapMethod: noCap + equityExchangeRate: 4.965218492984954 + equityDividendYield: 7.457744773683766 + equityIndexVolatility: 6.84685269835264 + bankLoans: + ignoreSinkingFund: true + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + structuredProducts: + balloonExtension: + months: 9 + percentage: 3.616076749251911 + units: units + amortizationType: Loan_Amort_None + couponStepup: 2.027123023002322 + prepayLockout: + pointsAbove: ANY + ymAbove: ANY + doOPTRedeem: doOPTRedeem + ignoreFinancialGuarantee: ignoreFinancialGuarantee + servicerAdvances: + principal: 5.962133916683182 + interest: 5.637376656633329 + advanceType: Advances All + cleanUpCallMethod: true + cashflows: + optionalRedemptionCallWhenUnits: Manual + optionalRedemptionCallWhen: 2 + recoveryLag: 7 + face: 9.965781217890562 + municipalBonds: + useAnticipatedSinkSchedule: true + ignoreSinkingFund: true + attribution: + startPrice: 4.145608029883936 + pricingMethod: Inputted Price + startSpread: 1.2315135367772556 + endPrice: 7.386281948385884 + endSpread: 1.0246457001441578 + matrixSpreadAdjustment: 6.027456183070403 meta: - type: object - type: object - ComponentSummary: - example: - name: name - category: category - properties: - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - ComponentSummaryRoot: - example: - data: - key: - name: name - category: category - meta: '{}' + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: data: - additionalProperties: - $ref: '#/components/schemas/ComponentSummary' - type: object + $ref: '#/components/schemas/FICalculationParameters' meta: - type: object - required: - - data - type: object - SPARComponent: - example: - path: path - name: name - id: id - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmarks: - prefix: prefix - returntype: returntype - id: id - currencyIsoCode: currencyIsoCode - category: category - properties: - id: - description: Component identifier. - type: string - accounts: - description: List of accounts in SPAR document. - items: - $ref: '#/components/schemas/SPARIdentifier' - type: array - benchmarks: - $ref: '#/components/schemas/SPARIdentifier' - currencyIsoCode: - description: CurrencyCode in SPAR document. - type: string - path: - description: The path to the document - type: string - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - SPARComponentRoot: - example: - data: - path: path - name: name - id: id - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmarks: - prefix: prefix - returntype: returntype - id: id - currencyIsoCode: currencyIsoCode - category: category - properties: - data: - $ref: '#/components/schemas/SPARComponent' + $ref: '#/components/schemas/CalculationMeta' type: object - VaultIdentifier: - description: The account/benchmark parameter for Vault calculation. + PaDoc: example: id: id properties: id: - description: User's FactSet account path OR benchmark. + description: PA document path type: string required: - id type: object - VaultDateParameters: - description: The date parameters for Vault calculation - example: - enddate: enddate - startdate: startdate - frequency: frequency - properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. - type: string - required: - - enddate - - frequency - type: object - VaultComponent: + FPOAccount: example: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - category: category - account: + paDocument: id: id - benchmark: - id: id - snapshot: true + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: + paDocument: + $ref: '#/components/schemas/PaDoc' id: - description: Vault component identifier - type: string - account: - $ref: '#/components/schemas/VaultIdentifier' - benchmark: - $ref: '#/components/schemas/VaultIdentifier' - currencyisocode: - description: Currency iso code saved in the document - type: string - dates: - $ref: '#/components/schemas/VaultDateParameters' - snapshot: - description: Snapshot - type: boolean - path: - description: The path to the document - type: string - name: - description: Component name. - type: string - category: - description: Component category. + description: Account path type: string - type: object - VaultComponentRoot: - example: - data: - currencyisocode: currencyisocode - path: path - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - category: category - account: - id: id - benchmark: - id: id - snapshot: true - meta: '{}' - properties: - data: - $ref: '#/components/schemas/VaultComponent' - meta: - type: object + overrides: + $ref: '#/components/schemas/OptimizerAccountOverrides' required: - - data + - paDocument type: object - VaultConfigurationSummary: + FPOObjective: example: - name: name + terms: + key: Disable + active: active properties: - name: - description: Configuration name. + active: type: string - type: object - VaultConfigurationSummaryRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: + terms: additionalProperties: - $ref: '#/components/schemas/VaultConfigurationSummary' - type: object - meta: + enum: + - Disable + - Enable + type: string type: object - required: - - data type: object - ConfigurationAccount: + FPOOptimizerStrategyOverrides: example: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName + alpha: alpha + transactionCost: transactionCost + constraints: + key: Disable + objective: + terms: + key: Disable + active: active properties: - benchmarkCode: - description: Benchmark code. - type: string - benchmarkName: - description: Benchmark name. - type: string - maxEndDate: - description: Maximum end date. - type: string - minStartDate: - description: Minimum start date. - type: string - lockingDate: - description: Locking date. + objective: + $ref: '#/components/schemas/FPOObjective' + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha type: string - name: - description: Account name. + transactionCost: + description: Transaction cost type: string type: object - VaultConfiguration: + FPOOptimizerStrategy: example: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName + overrides: + alpha: alpha + transactionCost: transactionCost + constraints: + key: Disable + objective: + terms: + key: Disable + active: active + id: id properties: - name: - description: Configuration name. + overrides: + $ref: '#/components/schemas/FPOOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path type: string - accounts: - additionalProperties: - $ref: '#/components/schemas/ConfigurationAccount' - type: object + required: + - id type: object - VaultConfigurationRoot: + FPOOptimizationParameters: + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + transactionCost: transactionCost + constraints: + key: Disable + objective: + terms: + key: Disable + active: active + id: id + account: + paDocument: + id: id + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + account: + $ref: '#/components/schemas/FPOAccount' + strategy: + $ref: '#/components/schemas/FPOOptimizerStrategy' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + FPOOptimizationParametersRoot: example: data: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + transactionCost: transactionCost + constraints: + key: Disable + objective: + terms: + key: Disable + active: active + id: id + account: + paDocument: + id: id + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark meta: '{}' properties: data: - $ref: '#/components/schemas/VaultConfiguration' + $ref: '#/components/schemas/FPOOptimizationParameters' meta: type: object - required: - - data type: object - Currency: - description: Details of the currency. + Frequency: example: name: name properties: name: - description: Name of currency. + description: Frequency name. type: string type: object - CurrencyRoot: + FrequencyRoot: example: data: key: @@ -28567,2134 +44252,2876 @@ components: properties: data: additionalProperties: - $ref: '#/components/schemas/Currency' - type: object - meta: + $ref: '#/components/schemas/Frequency' type: object - required: - - data - type: object - DateParametersSummary: - example: - enddate: enddate - startdate: startdate - properties: - startdate: - description: Start date in YYYYMMDD format. - type: string - enddate: - description: End date in YYYYMMDD format. - type: string - type: object - DateParametersSummaryRoot: - example: - data: - enddate: enddate - startdate: startdate - meta: '{}' - properties: - data: - $ref: '#/components/schemas/DateParametersSummary' meta: type: object required: - data type: object - FIDiscountCurveInfo: + Group: example: name: name - currency: currency category: category + directory: directory properties: - category: - type: string name: + description: Group Name type: string - currency: + directory: + description: Group Directory + type: string + category: + description: Group Category type: string type: object - FIDiscountCurveInfoRoot: + GroupRoot: example: data: key: name: name - currency: currency category: category + directory: directory meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/FIDiscountCurveInfo' + $ref: '#/components/schemas/Group' type: object meta: type: object required: - data type: object - DocumentDirectories: + TemplateContentTypes: example: - documents: - - documents - - documents - directories: - - directories - - directories + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - documents: - description: List of documents + mandatory: + description: Template mandatory fields items: type: string type: array - directories: - description: List of directories. + optional: + description: Template optional fields + items: + type: string + type: array + locked: + description: Template locked fields items: type: string type: array type: object - DocumentDirectoriesRoot: - example: - data: - documents: - - documents - - documents - directories: - - directories - - directories - meta: '{}' - properties: - data: - $ref: '#/components/schemas/DocumentDirectories' - meta: - type: object - required: - - data - type: object - FIABIdentifier: + LinkedPATemplateParameters: example: - id: id + parentComponentId: parentComponentId + description: description + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - id: - description: User's FactSet account path. + directory: + description: The directory to create a linked PA template type: string - required: - - id - type: object - FIABDateParameters: - description: The date parameters for FIAB calculations. - example: - enddate: enddate - startdate: startdate - properties: - startdate: - description: Calculation's start date. + parentComponentId: + description: Parent component id type: string - enddate: - description: Calculation's end date. + description: + description: Template description type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' required: - - enddate - - startdate + - directory + - parentComponentId type: object - FIABCalculationParameters: + LinkedPATemplateParametersRoot: example: - fiabdocument: fiabdocument - msl: msl - dates: - enddate: enddate - startdate: startdate - fisettingsdocument: fisettingsdocument - account: - id: id + data: + parentComponentId: parentComponentId + description: description + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: '{}' properties: - fiabdocument: - description: "FiabDocument (optional) - FIAB document to use as a template.\ - \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" - type: string - account: - $ref: '#/components/schemas/FIABIdentifier' - dates: - $ref: '#/components/schemas/FIABDateParameters' - msl: - description: Master FISecurity List. Analytics results will be written to - the selected MSL. Expects a GUI-style path (Client:/foo/bar) - type: string - fisettingsdocument: - description: "FISettingsDocument (optional) - The given @FIS document will\ - \ be used to\r\nconfigure analytics assumptions and settings. Expects\ - \ a GUI-style path (Client:/foo/bar)" - type: string + data: + $ref: '#/components/schemas/LinkedPATemplateParameters' + meta: + type: object required: - - account - - dates + - data type: object - FIABCalculationStatusSummary: + LinkedPATemplatePostSummary: + example: + parentComponentId: parentComponentId + name: name + description: description + id: id properties: - requesttime: - description: Request time of calculation. - format: date-time + id: + description: Template id. type: string - lastpolltime: - description: Last poll time of calculation. - format: date-time + description: + description: Template description. + type: string + name: + description: Template name. + type: string + parentComponentId: + description: Template parent tile. type: string type: object - EventSummary: + LinkedPATemplatePostSummaryRoot: example: - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type + data: + parentComponentId: parentComponentId + name: name + description: description + id: id + meta: '{}' properties: - message: - description: Event's message + data: + $ref: '#/components/schemas/LinkedPATemplatePostSummary' + meta: + type: object + required: + - data + type: object + LinkedPATemplateSummary: + example: + parentComponentId: parentComponentId + name: name + description: description + properties: + description: + description: Template description. type: string - submissiondatetime: - description: Event's submission time - format: date-time + name: + description: Template name. type: string - type: - description: Event's type + parentComponentId: + description: Template parent tile. type: string type: object - FIABCalculationStatus: + LinkedPATemplateSummaryRoot: example: - completiondatetime: 2000-01-23T04:56:07.000+00:00 - batchevents: - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - progress: 0 - id: id - status: Pending - startdatetime: 2000-01-23T04:56:07.000+00:00 + data: + key: + parentComponentId: parentComponentId + name: name + description: description + meta: '{}' properties: - id: - description: Calculation's identifier - type: string - status: - description: Calculation's status - enum: - - Pending - - InProgress - - Done - - Paused - - Cancelled - - Error - type: string - startdatetime: - description: Start time - format: date-time + data: + additionalProperties: + $ref: '#/components/schemas/LinkedPATemplateSummary' + type: object + meta: + type: object + required: + - data + type: object + LinkedPATemplateUpdateParameters: + example: + parentComponentId: parentComponentId + description: description + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + properties: + parentComponentId: + description: Parent component id type: string - completiondatetime: - description: Completion time - format: date-time + description: + description: Template description type: string - progress: - description: Calculation's progress - format: int32 - type: integer - batchevents: - description: List of batch events - items: - $ref: '#/components/schemas/EventSummary' - type: array + content: + $ref: '#/components/schemas/TemplateContentTypes' type: object - FIReferencePrepay: + LinkedPATemplateUpdateParametersRoot: example: - prepayName: prepayName + data: + parentComponentId: parentComponentId + description: description + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: '{}' properties: - prepayName: - description: Reference Prepay Name - type: string + data: + $ref: '#/components/schemas/LinkedPATemplateUpdateParameters' + meta: + type: object + required: + - data type: object - FIReferenceSecurity: + LinkedPATemplate: example: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement + parentComponentId: parentComponentId + name: name + description: description + id: id + directory: directory + snapshot: true + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - securityType: - description: Reference Security Type + directory: + description: Template directory. type: string - securityName: - description: Reference Security Name + snapshot: + description: snapshot. + type: boolean + content: + $ref: '#/components/schemas/TemplateContentTypes' + id: + description: Template id. type: string - calcFromMethod: - description: "Reference Calculation Method.\r\nMethods : Active Spread,\ - \ Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield\ - \ To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield\ - \ To Worst Call, Discount Yield, Discount Margin, Implied Volatility,\ - \ Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + description: + description: Template description. type: string - calcFromValue: - description: Reference CalcFromValue - format: double - type: number - prepay: - $ref: '#/components/schemas/FIReferencePrepay' - settlement: - description: Reference Settlement Date + name: + description: Template name. + type: string + parentComponentId: + description: Template parent tile. type: string type: object - FIBankLoans: + LinkedPATemplateRoot: example: - ignoreSinkingFund: true + data: + parentComponentId: parentComponentId + name: name + description: description + id: id + directory: directory + snapshot: true + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: '{}' properties: - ignoreSinkingFund: - description: Ignore Sinking Fund - type: boolean + data: + $ref: '#/components/schemas/LinkedPATemplate' + meta: + type: object + required: + - data type: object - FIMunicipalBonds: + NPOOptimizerStrategyOverrides: example: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' properties: - ignoreSinkingFund: - description: Ignore Sinking Fund Schedule - type: boolean - useAnticipatedSinkSchedule: - description: Anticipate Sink Schedule - type: boolean + objective: + additionalProperties: + type: object + description: Objective parameters + type: object + constraints: + description: List of constraints + items: + $ref: '#/components/schemas/ConstraintAction' + type: array + tax: + description: "Tax\r\nCan be set to \"\" for local" + type: string + transactionCost: + description: "Transaction cost\r\nCan be set to \"\" for local" + type: string + alpha: + description: Alpha + type: string type: object - FILoss: + NPOOptimizerStrategy: example: - lossName: lossName + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id properties: - lossName: - description: Loss Name + overrides: + $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path type: string + required: + - id type: object - FIPrepay: + NPOOptimizationParameters: example: - prepayName: prepayName + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: - prepayName: - description: Prepay Name - type: string + strategy: + $ref: '#/components/schemas/NPOOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy type: object - FIServicerAdvancesForSecurities: + NPOOptimizationParametersRoot: example: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + objective: + key: '{}' + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' properties: - principal: - description: Principal - format: double - type: number - interest: - description: Interest - format: double - type: number - advanceType: - description: Advance Type - enum: - - Advances All - - Advances All But Newly Liqdtd - - Does Not Advance - - Principal Only - - Interest Only - type: string + data: + $ref: '#/components/schemas/NPOOptimizationParameters' + meta: + type: object type: object - FIPrepayLockout: + PACalculationGroup: example: - pointsAbove: ANY - ymAbove: ANY + id: id + frequency: frequency properties: - pointsAbove: - description: Points Above - enum: - - ANY - - NO_LOCKOUT - - NUMERIC + id: + description: FactSet-defined or User-defined Group identifier. type: string - ymAbove: - description: Ym Above - enum: - - ANY - - NO_LOCKOUT - - NUMERIC + frequency: + description: Grouping frequency type: string type: object - FICashflows: + PACalculationColumn: example: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + id: id + statistics: + - statistics + - statistics properties: - optionalRedemptionCallWhenUnits: - description: OptionalRedemptionCallWhenUnits - enum: - - Manual - - Never - - ASAP - - Date - - Deal Closing - - Settle Date + id: + description: FactSet-defined or User-defined Column identifier. type: string - optionalRedemptionCallWhen: - description: OptionalRedemptionCallWhen - format: int32 - type: integer - recoveryLag: - description: RecoveryLag - format: int32 - type: integer + statistics: + description: Column Statistic identifier + items: + type: string + type: array type: object - FIBalloonExtension: + PACalculationPricingSource: example: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 + id: id properties: - months: - description: Months - format: int32 - type: integer - percentage: - description: Percentage - format: double - type: number - amortizationType: - description: Amortization Type - enum: - - Loan_Amort_None - - Loan_Amort_Regular - - Loan_Amort_Default - type: string - units: - description: Units + id: + description: Pricing source identifier type: string - couponStepup: - description: Coupon Stepup - format: double - type: number type: object - FIStructuredProductsForSecurities: + PACalculationDataSources: example: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id properties: - servicerAdvances: - $ref: '#/components/schemas/FIServicerAdvancesForSecurities' - ignoreFinancialGuarantee: - description: Ignore Financial Guarantee - type: string - cleanUpCallMethod: - description: Cleanup Call Method + portfoliopricingsources: + description: List of portfilio pricing source for the PA calculation + items: + $ref: '#/components/schemas/PACalculationPricingSource' + type: array + benchmarkpricingsources: + description: List of benchmark pricing source for the PA calculation + items: + $ref: '#/components/schemas/PACalculationPricingSource' + type: array + useportfoliopricingsourcesforbenchmark: + description: Use portfolio pricing sources for benchmark type: boolean - doOPTRedeem: - description: Do OPT Redeem - type: string - prepayLockout: - $ref: '#/components/schemas/FIPrepayLockout' - cashflows: - $ref: '#/components/schemas/FICashflows' - balloonExtension: - $ref: '#/components/schemas/FIBalloonExtension' type: object - FIAttributionForSecurities: + PACalculationParameters: example: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 + currencyisocode: currencyisocode + componentdetail: componentdetail + componentid: componentid + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode properties: - startPrice: - description: Start Price - format: double - type: number - endPrice: - description: End Price - format: double - type: number - startSpread: - description: Start Spread - format: double - type: number - endSpread: - description: End Spread - format: double - type: number - pricingMethod: - description: Pricing Method - enum: - - Inputted Price - - Pricing Matrix - - Actual Spread - - OAS + componentid: + description: The PA Engine component identifier to analyze. + type: string + accounts: + description: List of accounts. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + dates: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation. This will take precedence + over the groupings saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationGroup' + type: array + currencyisocode: + description: Currency ISO code for calculation. + type: string + columns: + description: List of columns for the PA calculation. This will take precedence + over the columns saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array + datasources: + $ref: '#/components/schemas/PACalculationDataSources' + componentdetail: + description: Component detail type for the PA component. It can be GROUPS + or GROUPSALL or TOTALS or SECURITIES. type: string + required: + - componentid type: object - FIConvertibleSettings: + PACalculationParametersRoot: example: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + data: + key: + currencyisocode: currencyisocode + componentdetail: componentdetail + componentid: componentid + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: - equityPrice: - description: Equity Price - format: double - type: number - equityIndexVolatility: - description: Equity Index Volatility - format: double - type: number - equityDividendYield: - description: Equity Dividend Yield - format: double - type: number - volatilityCapMethod: - description: Volatility CapMethod - enum: - - noCap - - specifiedRate - - multiplier - type: string - volatilityCapMethodValue: - description: Volatility CapMethod Value - (Required only when volatilityCapMethod - is specifiedRate or multiplier) - format: double - type: number - equityExchangeRate: - description: Equity Exchange Rate - format: double - type: number + data: + additionalProperties: + $ref: '#/components/schemas/PACalculationParameters' + description: List of calculation parameters. + type: object + meta: + $ref: '#/components/schemas/CalculationMeta' type: object - FISecurity: + CalculationUnitStatus: + description: The status of the calculation as per FactSets API standards example: - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 9.965781217890562 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 properties: - settlement: - description: Settlement date - type: string - callMethod: - description: Call Method + status: + description: The status of calculation unit. enum: - - No Call - - Intrinsic Value - - First Call - - First Par + - Queued + - Executing + - Success + - Failed + - Cancelled type: string - referenceSecurity: - $ref: '#/components/schemas/FIReferenceSecurity' - bankLoans: - $ref: '#/components/schemas/FIBankLoans' - municipalBonds: - $ref: '#/components/schemas/FIMunicipalBonds' - loss: - $ref: '#/components/schemas/FILoss' - prepay: - $ref: '#/components/schemas/FIPrepay' - matrixSpreadAdjustment: - description: Matrix Spread Adjustment - format: double - type: number - matrixMultiplier: - description: Matrix Multiplier - format: double - type: number - structuredProducts: - $ref: '#/components/schemas/FIStructuredProductsForSecurities' - attribution: - $ref: '#/components/schemas/FIAttributionForSecurities' - convertible: - $ref: '#/components/schemas/FIConvertibleSettings' - calcFromMethod: - description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ - \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ - \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ - \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ - \ To Worst Call, Pricing Matrix" + errors: + description: The error in a calculation unit. + items: + $ref: '#/components/schemas/Error' + type: array + result: + description: The result URL of the calculation. + type: string + progress: + description: The progress of the calculation unit. + type: string + points: + 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: + description: Details of the calculation. + example: + calculationid: calculationid + units: + key: + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 + status: Queued + properties: + calculationid: + description: Calculation's identifier type: string - calcFromValue: - description: Calculation from value - format: double - type: number - face: - default: 1 - description: Face - format: double - type: number - faceType: - default: Current - description: Face type + status: + description: Calculation's status enum: - - Current - - Original - type: string - symbol: - description: Symbol + - Queued + - Executing + - Completed + - Cancelled type: string - discountCurve: - description: Discount curve + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatus' + description: Number of calculation units in batch. + type: object + type: object + CalculationUnitStatusMeta: + description: Meta of the calculation unit. + example: + info: info + properties: + info: + description: The Info URL of the calculation. type: string - required: - - calcFromValue - - symbol type: object - FIMunicipalBondsForJobSettings: + CalculationStatusMeta: + description: Meta of calculation units in batch. example: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true + units: + key: + info: info properties: - allowSinkForInstallmentPayment: - description: Allow Sink For Installment Payment - type: boolean - ignoreSinkingFund: - description: Ignore Sinking Fund Schedule - type: boolean - useAnticipatedSinkSchedule: - description: Anticipate Sink Schedule - type: boolean + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatusMeta' + description: List of calculation units in batch. + type: object type: object - FIMarketEnvironment: + CalculationStatusRoot: example: - ratePath: FLAT & FORWARD + data: + calculationid: calculationid + units: + key: + result: result + warnings: + - warnings + - warnings + progress: progress + errors: + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + - code: code + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + title: title + status: Queued + points: 0 + status: Queued + meta: + units: + key: + info: info properties: - ratePath: - default: FLAT & FORWARD - description: Rate Path - enum: - - FLAT - - FORWARD - - FLAT & FORWARD - type: string + data: + $ref: '#/components/schemas/CalculationStatus' + meta: + $ref: '#/components/schemas/CalculationStatusMeta' + required: + - data type: object - FIServicerAdvances: + CalculationsSummary: example: - advanceType: Advances All + requestTime: 2000-01-23T04:56:07.000+00:00 + lastPollTime: 2000-01-23T04:56:07.000+00:00 + units: 0 + status: Queued properties: - advanceType: - description: Advance Type + status: + description: Last poll status of the calculation. enum: - - Advances All - - Advances All But Newly Liqdtd - - Does Not Advance - - Principal Only - - Interest Only + - Queued + - Executing + - Completed + - Cancelled + type: string + units: + description: Number of calculation units in batch. + format: int32 + type: integer + requestTime: + description: Request time of calculation. + format: date-time + type: string + lastPollTime: + description: Last poll time of calculation. + format: date-time type: string type: object - FIStructuredProductsForJobSettings: + PaginationInfo: example: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 properties: - servicerAdvances: - $ref: '#/components/schemas/FIServicerAdvances' - ignoreFinancialGuarantee: - description: Ignore Financial Guarantee + pageNumber: + format: int32 + type: integer + pageSize: + format: int32 + type: integer + totalPages: + format: int32 + type: integer + totalCalculations: + format: int32 + type: integer + nextPage: type: string - cleanUpCallMethod: - description: Cleanup Call Method - type: boolean - doOPTRedeem: - description: Do OPT Redeem + previousPage: type: string - prepayLockout: - $ref: '#/components/schemas/FIPrepayLockout' - cashflows: - $ref: '#/components/schemas/FICashflows' - balloonExtension: - $ref: '#/components/schemas/FIBalloonExtension' type: object - FIAttributionForJobSettings: + PaginationMeta: + example: + pagination: + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 + properties: + pagination: + $ref: '#/components/schemas/PaginationInfo' + type: object + CalculationsSummaryRoot: + example: + data: + key: + requestTime: 2000-01-23T04:56:07.000+00:00 + lastPollTime: 2000-01-23T04:56:07.000+00:00 + units: 0 + status: Queued + meta: + pagination: + pageNumber: 6 + previousPage: previousPage + nextPage: nextPage + totalPages: 5 + pageSize: 1 + totalCalculations: 5 + properties: + data: + additionalProperties: + $ref: '#/components/schemas/CalculationsSummary' + type: object + meta: + $ref: '#/components/schemas/PaginationMeta' + required: + - data + type: object + PACommentaryParameters: + example: + configurationid: configurationid + properties: + configurationid: + description: Commentary configuration id + type: string + type: object + PACommentaryParametersRoot: + example: + data: + configurationid: configurationid + meta: '{}' + properties: + data: + $ref: '#/components/schemas/PACommentaryParameters' + meta: + type: object + required: + - data + type: object + PACommentaryDate: example: - endDate: endDate - startDate: startDate + yyyymmdd: 0 + relative: relative properties: - startDate: - description: Start Date - type: string - endDate: - description: End Date + yyyymmdd: + description: Date can be either absolute (YYYYMMDD) or relative, but only + one format should be set at a time. + format: int32 + type: integer + relative: + description: Date can be either relative or absolute (YYYYMMDD), but only + one format should be set at a time. type: string type: object - FIJobSettings: + Metadata: example: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 9 - - 9 - settlement: settlement + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency properties: - asOfDate: - description: As of date - type: string - partialDurationMonths: - description: Partial duration months - items: - format: int32 - type: integer - type: array - callMethod: - description: Call Method - enum: - - No Call - - Intrinsic Value - - First Call - - First Par - type: string - settlement: - description: Settlement Date - type: string - calcFromMethod: - description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ - \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ - \ Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount\ - \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ - \ To Worst Call, Pricing Matrix" + tileName: + description: PA Tile name associated with the component type: string - bankLoans: - $ref: '#/components/schemas/FIBankLoans' - municipalBonds: - $ref: '#/components/schemas/FIMunicipalBondsForJobSettings' - marketEnvironment: - $ref: '#/components/schemas/FIMarketEnvironment' - structuredProducts: - $ref: '#/components/schemas/FIStructuredProductsForJobSettings' - attribution: - $ref: '#/components/schemas/FIAttributionForJobSettings' - required: - - asOfDate - type: object - FICalculationParameters: - example: - jobSettings: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 9 - - 9 - settlement: settlement - calculations: - - calculations - - calculations - securities: - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 9.965781217890562 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 9.965781217890562 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + portfolioDescription: + description: Portfolio name used in generating commentary + type: string + benchmarkDescription: + description: Benchmark name used in generating commentary + type: string + startDate: + $ref: '#/components/schemas/PACommentaryDate' + endDate: + $ref: '#/components/schemas/PACommentaryDate' + frequency: + description: Date frequency + type: string + type: object + Section: + example: + metadata: + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency + subSections: + - null + - null + title: title + content: content properties: - securities: - description: List of securities - items: - $ref: '#/components/schemas/FISecurity' - type: array - calculations: - description: List of calculations + metadata: + $ref: '#/components/schemas/Metadata' + title: + description: Commentary title + type: string + content: + description: Generated commentary content + type: string + subSections: + description: Generated commentary subsections items: - type: string + $ref: '#/components/schemas/Section' type: array - jobSettings: - $ref: '#/components/schemas/FIJobSettings' - required: - - calculations - - jobSettings - - securities type: object - CalculationMeta: + PACommentary: example: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + commentaryId: commentaryId + sections: + - metadata: + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency + subSections: + - null + - null + title: title + content: content + - metadata: + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency + subSections: + - null + - null + title: title + content: content + disclaimer: disclaimer properties: - contentorganization: - default: SimplifiedRow - deprecated: true - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - stachContentOrganization: - default: SimplifiedRow - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - contenttype: - default: Json - deprecated: true - enum: - - Json - - Binary + commentaryId: + description: Generated commentary Id type: string - format: - default: JsonStach - enum: - - JsonStach - - Table - - Tableau - - BinaryStach - - Bison - - Binary - - Pdf - - Pptx - - Feather + sections: + description: Commentary sections + items: + $ref: '#/components/schemas/Section' + type: array + disclaimer: + description: Disclaimer type: string type: object - FICalculationParametersRoot: + PACommentaryRoot: example: data: - jobSettings: - callMethod: No Call - calcFromMethod: calcFromMethod - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - allowSinkForInstallmentPayment: true - attribution: - endDate: endDate - startDate: startDate - marketEnvironment: - ratePath: FLAT & FORWARD - asOfDate: asOfDate - bankLoans: - ignoreSinkingFund: true - partialDurationMonths: - - 9 - - 9 - settlement: settlement - calculations: - - calculations - - calculations - securities: - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 9.965781217890562 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 - - callMethod: No Call - symbol: symbol - matrixMultiplier: 1.4658129805029452 - discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - bankLoans: - ignoreSinkingFund: true - faceType: Current - referenceSecurity: - calcFromMethod: calcFromMethod - prepay: - prepayName: prepayName - securityName: securityName - calcFromValue: 0.8008281904610115 - securityType: securityType - settlement: settlement - settlement: settlement - calcFromMethod: calcFromMethod - loss: - lossName: lossName - prepay: - prepayName: prepayName - structuredProducts: - balloonExtension: - months: 9 - percentage: 3.616076749251911 - units: units - amortizationType: Loan_Amort_None - couponStepup: 2.027123023002322 - prepayLockout: - pointsAbove: ANY - ymAbove: ANY - doOPTRedeem: doOPTRedeem - ignoreFinancialGuarantee: ignoreFinancialGuarantee - servicerAdvances: - principal: 5.962133916683182 - interest: 5.637376656633329 - advanceType: Advances All - cleanUpCallMethod: true - cashflows: - optionalRedemptionCallWhenUnits: Manual - optionalRedemptionCallWhen: 2 - recoveryLag: 7 - face: 9.965781217890562 - municipalBonds: - useAnticipatedSinkSchedule: true - ignoreSinkingFund: true - attribution: - startPrice: 4.145608029883936 - pricingMethod: Inputted Price - startSpread: 1.2315135367772556 - endPrice: 7.386281948385884 - endSpread: 1.0246457001441578 - matrixSpreadAdjustment: 6.027456183070403 + commentaryId: commentaryId + sections: + - metadata: + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency + subSections: + - null + - null + title: title + content: content + - metadata: + benchmarkDescription: benchmarkDescription + endDate: + yyyymmdd: 0 + relative: relative + portfolioDescription: portfolioDescription + startDate: + yyyymmdd: 0 + relative: relative + tileName: tileName + frequency: frequency + subSections: + - null + - null + title: title + content: content + disclaimer: disclaimer + meta: '{}' + properties: + data: + $ref: '#/components/schemas/PACommentary' + meta: + type: object + required: + - data + type: object + PACommentaryGetStatus: + properties: + calculationid: + description: Calculation id. + type: string + unitid: + description: Calculation unit id. + type: string + status: + description: The status of commentary generation. + enum: + - Executing + - Success + type: string + type: object + PACommentaryGetStatusRoot: + properties: + data: + $ref: '#/components/schemas/PACommentaryGetStatus' meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + type: object + required: + - data + type: object + PACommentaryStatus: + example: + result: result + calculationid: calculationid + unitid: unitid + status: Executing + properties: + result: + description: The result url of the generated commentary. + type: string + calculationid: + description: Calculation id. + type: string + unitid: + description: Calculation unit id. + type: string + status: + description: The status of commentary generation. + enum: + - Executing + - Success + type: string + type: object + PACommentaryStatusRoot: + example: + data: + result: result + calculationid: calculationid + unitid: unitid + status: Executing + meta: '{}' properties: data: - $ref: '#/components/schemas/FICalculationParameters' + $ref: '#/components/schemas/PACommentaryStatus' meta: - $ref: '#/components/schemas/CalculationMeta' + type: object + required: + - data type: object - Frequency: + PAPricingSource: example: name: name + category: category + directory: directory properties: name: - description: Frequency name. + description: Pricing source Name + type: string + directory: + description: Pricing source directory + type: string + category: + description: Pricing source category type: string type: object - FrequencyRoot: + PAPricingSourceRoot: example: data: key: name: name + category: category + directory: directory meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/Frequency' + $ref: '#/components/schemas/PAPricingSource' type: object meta: type: object required: - data type: object - NPOOptimizerStrategyOverrides: + PubIdentifier: example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' + id: id + holdingsmode: holdingsmode properties: - objective: + id: + description: User's FactSet account path OR benchmark. + type: string + holdingsmode: + description: Holdings Mode can be B&H, TBR, OMS or EXT. + type: string + required: + - id + type: object + PubDateParameters: + description: The date parameters for Publisher calculation. + example: + enddate: enddate + startdate: startdate + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date or as of date. + type: string + required: + - enddate + type: object + PubCalculationParameters: + example: + document: document + dates: + enddate: enddate + startdate: startdate + account: + id: id + holdingsmode: holdingsmode + properties: + document: + description: The Publisher Engine document to analyze. + type: string + account: + $ref: '#/components/schemas/PubIdentifier' + dates: + $ref: '#/components/schemas/PubDateParameters' + required: + - account + - dates + - document + type: object + PubCalculationMeta: + type: object + PubCalculationParametersRoot: + example: + data: + key: + document: document + dates: + enddate: enddate + startdate: startdate + account: + id: id + holdingsmode: holdingsmode + meta: '{}' + properties: + data: additionalProperties: - type: object - description: Objective parameters + $ref: '#/components/schemas/PubCalculationParameters' + description: List of calculation parameters. type: object - constraints: - description: List of constraints + meta: + type: object + type: object + QuantScreeningExpressionUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' + properties: + universeExpr: + type: string + universeType: + enum: + - Equity + - Debt + type: string + securityExpr: + type: string + required: + - universeExpr + - universeType + type: object + QuantIdentifierUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' + properties: + universeType: + enum: + - Equity + - Debt + type: string + identifiers: items: - $ref: '#/components/schemas/ConstraintAction' + type: string type: array - tax: - description: "Tax\r\nCan be set to \"\" for local" + required: + - identifiers + - universeType + type: object + QuantUniverse: + properties: + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse type: string - transactionCost: - description: "Transaction cost\r\nCan be set to \"\" for local" + required: + - source + type: object + QuantUniversalScreenUniverse: + allOf: + - $ref: '#/components/schemas/QuantUniverse' + properties: + screen: type: string - alpha: - description: Alpha + required: + - screen + type: object + QuantDateList: + allOf: + - $ref: '#/components/schemas/QuantDate' + properties: + dates: + items: + type: string + type: array + type: object + QuantDate: + properties: + source: + enum: + - FdsDate + - DateList + type: string + frequency: + type: string + calendar: + type: string + overrideUniversalScreenCalendar: + type: boolean + required: + - calendar + - frequency + - source + type: object + QuantFdsDate: + allOf: + - $ref: '#/components/schemas/QuantDate' + properties: + startDate: + type: string + endDate: + type: string + required: + - endDate + - startDate + type: object + QuantFqlExpression: + allOf: + - $ref: '#/components/schemas/QuantFormula' + properties: + expr: + type: string + name: + type: string + dateOffset: + type: string + isArrayReturnType: + type: boolean + required: + - expr + - name + type: object + QuantUniversalScreenParameter: + allOf: + - $ref: '#/components/schemas/QuantFormula' + properties: + referenceName: + type: string + name: type: string + required: + - name + - referenceName type: object - NPOOptimizerStrategy: - example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id + QuantAllUniversalScreenParameters: + allOf: + - $ref: '#/components/schemas/QuantFormula' + type: object + QuantFormula: properties: - overrides: - $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path + source: + enum: + - ScreeningExpression + - FqlExpression + - UniversalScreenParameter + - AllUniversalScreenParameters type: string required: - - id + - source type: object - NPOOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark + QuantScreeningExpression: + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - strategy: - $ref: '#/components/schemas/NPOOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' + expr: + type: string + name: + type: string + dateOffset: + type: string required: - - outputTypes - - strategy + - expr + - name type: object - NPOOptimizationParametersRoot: + OneOfQuantUniverse: + discriminator: + mapping: + UniversalScreenUniverse: '#/components/schemas/QuantUniversalScreenUniverse' + ScreeningExpressionUniverse: '#/components/schemas/QuantScreeningExpressionUniverse' + IdentifierUniverse: '#/components/schemas/QuantIdentifierUniverse' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantUniversalScreenUniverse' + - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' + - $ref: '#/components/schemas/QuantIdentifierUniverse' + OneOfQuantDates: + discriminator: + mapping: + FdsDate: '#/components/schemas/QuantFdsDate' + DateList: '#/components/schemas/QuantDateList' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantFdsDate' + - $ref: '#/components/schemas/QuantDateList' + OneOfQuantFormulas: + discriminator: + mapping: + ScreeningExpression: '#/components/schemas/QuantScreeningExpression' + FqlExpression: '#/components/schemas/QuantFqlExpression' + UniversalScreenParameter: '#/components/schemas/QuantUniversalScreenParameter' + AllUniversalScreenParameters: '#/components/schemas/QuantAllUniversalScreenParameters' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantScreeningExpression' + - $ref: '#/components/schemas/QuantFqlExpression' + - $ref: '#/components/schemas/QuantUniversalScreenParameter' + - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' + OneOfQuantFormulasArray: + items: + $ref: '#/components/schemas/OneOfQuantFormulas' + type: array + QuantCalculationParameters: example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' + formulas: + - null + - null + jobDescription: jobDescription properties: - data: - $ref: '#/components/schemas/NPOOptimizationParameters' - meta: - type: object + universe: + $ref: '#/components/schemas/OneOfQuantUniverse' + dates: + $ref: '#/components/schemas/OneOfQuantDates' + formulas: + items: + $ref: '#/components/schemas/OneOfQuantFormulas' + type: array + jobDescription: + type: string type: object - PubIdentifier: + QuantCalculationMeta: example: - id: id - holdingsmode: holdingsmode + contentorganization: SimplifiedRow + allowArrayData: true + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: - id: - description: User's FactSet account path OR benchmark. + allowArrayData: + type: boolean + contentorganization: + default: SimplifiedRow + deprecated: true + enum: + - None + - Row + - Column + - SimplifiedRow type: string - holdingsmode: - description: Holdings Mode can be B&H, TBR, OMS or EXT. + stachContentOrganization: + default: SimplifiedRow + enum: + - None + - Row + - Column + - SimplifiedRow type: string - required: - - id + contenttype: + default: Json + deprecated: true + enum: + - Json + - Binary + type: string + format: + default: JsonStach + enum: + - JsonStach + - Table + - Tableau + - BinaryStach + - Bison + - Binary + - Pdf + - Pptx + - Feather + type: string + type: object + QuantCalculationParametersRoot: + example: + data: + key: + formulas: + - null + - null + jobDescription: jobDescription + meta: + contentorganization: SimplifiedRow + allowArrayData: true + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json + properties: + data: + additionalProperties: + $ref: '#/components/schemas/QuantCalculationParameters' + description: List of calculation parameters. + type: object + meta: + $ref: '#/components/schemas/QuantCalculationMeta' type: object - PubDateParameters: - description: The date parameters for Publisher calculation. + SPARDateParameters: + description: The date parameters for SPAR calculation. example: enddate: enddate startdate: startdate + useeachportfolioinception: true + frequency: frequency properties: startdate: description: Calculation's start date. type: string enddate: - description: Calculation's end date or as of date. + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. type: string + useeachportfolioinception: + description: Use Each Portfolio Inception + type: boolean required: - enddate + - frequency + - startdate type: object - PubCalculationParameters: + SPARCalculationParameters: example: - document: document + currencyisocode: currencyisocode + componentid: componentid dates: enddate: enddate startdate: startdate - account: + useeachportfolioinception: true + frequency: frequency + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype id: id - holdingsmode: holdingsmode properties: - document: - description: The Publisher Engine document to analyze. + componentid: + description: The SPAR Engine component identifier to analyze. type: string - account: - $ref: '#/components/schemas/PubIdentifier' + accounts: + description: List of accounts for SPAR calculation. + items: + $ref: '#/components/schemas/SPARIdentifier' + type: array + benchmark: + $ref: '#/components/schemas/SPARIdentifier' dates: - $ref: '#/components/schemas/PubDateParameters' + $ref: '#/components/schemas/SPARDateParameters' + currencyisocode: + description: Currency ISO code for calculation. + type: string required: - - account - - dates - - document - type: object - PubCalculationMeta: + - componentid type: object - PubCalculationParametersRoot: + SPARCalculationParametersRoot: example: data: key: - document: document + currencyisocode: currencyisocode + componentid: componentid dates: enddate: enddate startdate: startdate - account: + useeachportfolioinception: true + frequency: frequency + accounts: + - prefix: prefix + returntype: returntype id: id - holdingsmode: holdingsmode - meta: '{}' + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype + id: id + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: data: additionalProperties: - $ref: '#/components/schemas/PubCalculationParameters' + $ref: '#/components/schemas/SPARCalculationParameters' description: List of calculation parameters. type: object meta: - type: object + $ref: '#/components/schemas/CalculationMeta' type: object - CalculationUnitStatus: - description: The status of the calculation as per FactSets API standards + PAComponentData: example: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode properties: - status: - description: The status of calculation unit. - enum: - - Queued - - Executing - - Success - - Failed - - Cancelled - type: string - errors: - description: The error in a calculation unit. + accounts: + description: List of accounts. items: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/PAIdentifier' type: array - result: - description: The result URL of the calculation. - type: string - progress: - description: The progress of the calculation unit. - type: string - points: - description: The points for the calculation unit. - format: int32 - type: integer - warnings: - description: The warnings in a calculation unit. + benchmarks: + description: List of benchmarks. items: - type: string + $ref: '#/components/schemas/PAIdentifier' + type: array + groups: + description: List of groupings for the PA calculation. This will take precedence + over the groupings saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationGroup' + type: array + columns: + description: List of columns for the PA calculation. This will take precedence + over the columns saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationColumn' type: array + dates: + $ref: '#/components/schemas/PADateParameters' + datasources: + $ref: '#/components/schemas/PACalculationDataSources' + currencyisocode: + description: Currency ISO code for calculation. + type: string + componentdetail: + description: PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. + type: string type: object - CalculationStatus: - description: Details of the calculation. + TemplatedPAComponentParameters: example: - calculationid: calculationid - units: - key: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 - status: Queued + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory properties: - calculationid: - description: Calculation's identifier + directory: + description: Directory to create templated components type: string - status: - description: Calculation's status - enum: - - Queued - - Executing - - Completed - - Cancelled + parentTemplateId: + description: Parent template id type: string - units: - additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatus' - description: Number of calculation units in batch. - type: object + description: + description: Component description. + type: string + componentData: + $ref: '#/components/schemas/PAComponentData' + required: + - directory + - parentTemplateId type: object - CalculationUnitStatusMeta: - description: Meta of the calculation unit. + TemplatedPAComponentParametersRoot: example: - info: info + data: + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory + meta: '{}' properties: - info: - description: The Info URL of the calculation. - type: string + data: + $ref: '#/components/schemas/TemplatedPAComponentParameters' + meta: + type: object + required: + - data type: object - CalculationStatusMeta: - description: Meta of calculation units in batch. + TemplatedPAComponentPostSummary: example: - units: - key: - info: info + parentTemplateId: parentTemplateId + name: name + description: description + id: id + type: type properties: - units: - additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatusMeta' - description: List of calculation units in batch. - type: object + id: + type: string + description: + type: string + name: + type: string + parentTemplateId: + type: string + type: + type: string type: object - CalculationStatusRoot: + TemplatedPAComponentPostSummaryRoot: example: data: - calculationid: calculationid - units: - key: - result: result - warnings: - - warnings - - warnings - progress: progress - errors: - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - - code: code - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - title: title - status: Queued - points: 0 - status: Queued - meta: - units: - key: - info: info + parentTemplateId: parentTemplateId + name: name + description: description + id: id + type: type + meta: '{}' properties: data: - $ref: '#/components/schemas/CalculationStatus' + $ref: '#/components/schemas/TemplatedPAComponentPostSummary' meta: - $ref: '#/components/schemas/CalculationStatusMeta' + type: object required: - data type: object - CalculationsSummary: + TemplatedPAComponentSummary: example: - requestTime: 2000-01-23T04:56:07.000+00:00 - lastPollTime: 2000-01-23T04:56:07.000+00:00 - units: 0 - status: Queued + parentTemplateId: parentTemplateId + name: name + description: description + type: type properties: - status: - description: Last poll status of the calculation. - enum: - - Queued - - Executing - - Completed - - Cancelled - type: string - units: - description: Number of calculation units in batch. - format: int32 - type: integer - requestTime: - description: Request time of calculation. - format: date-time + description: type: string - lastPollTime: - description: Last poll time of calculation. - format: date-time + name: type: string - type: object - PaginationInfo: - example: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 - properties: - pageNumber: - format: int32 - type: integer - pageSize: - format: int32 - type: integer - totalPages: - format: int32 - type: integer - totalCalculations: - format: int32 - type: integer - nextPage: + parentTemplateId: type: string - previousPage: + type: type: string type: object - PaginationMeta: - example: - pagination: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 - properties: - pagination: - $ref: '#/components/schemas/PaginationInfo' - type: object - CalculationsSummaryRoot: + TemplatedPAComponentSummaryRoot: example: data: key: - requestTime: 2000-01-23T04:56:07.000+00:00 - lastPollTime: 2000-01-23T04:56:07.000+00:00 - units: 0 - status: Queued - meta: - pagination: - pageNumber: 6 - previousPage: previousPage - nextPage: nextPage - totalPages: 5 - pageSize: 1 - totalCalculations: 5 + parentTemplateId: parentTemplateId + name: name + description: description + type: type + meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/CalculationsSummary' + $ref: '#/components/schemas/TemplatedPAComponentSummary' type: object meta: - $ref: '#/components/schemas/PaginationMeta' + type: object required: - data type: object - QuantScreeningExpressionUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' + TemplatedPAComponentUpdateParameters: + example: + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode properties: - universeExpr: - type: string - universeType: - enum: - - Equity - - Debt + parentTemplateId: + description: Parent template id type: string - securityExpr: + description: + description: Component description. type: string - required: - - universeExpr - - universeType + componentData: + $ref: '#/components/schemas/PAComponentData' type: object - QuantIdentifierUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' + TemplatedPAComponentUpdateParametersRoot: + example: + data: + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + meta: '{}' properties: - universeType: - enum: - - Equity - - Debt - type: string - identifiers: - items: - type: string - type: array + data: + $ref: '#/components/schemas/TemplatedPAComponentUpdateParameters' + meta: + type: object required: - - identifiers - - universeType + - data type: object - QuantUniverse: + TemplatedPAComponent: + example: + parentTemplateId: parentTemplateId + name: name + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + description: description + id: id + type: type + directory: directory + snapshot: true properties: - source: - enum: - - ScreeningExpressionUniverse - - UniversalScreenUniverse - - IdentifierUniverse + id: + type: string + directory: + type: string + snapshot: + type: boolean + componentData: + $ref: '#/components/schemas/PAComponentData' + description: + type: string + name: + type: string + parentTemplateId: + type: string + type: type: string - required: - - source type: object - QuantUniversalScreenUniverse: - allOf: - - $ref: '#/components/schemas/QuantUniverse' + TemplatedPAComponentRoot: + example: + data: + parentTemplateId: parentTemplateId + name: name + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + description: description + id: id + type: type + directory: directory + snapshot: true + meta: '{}' properties: - screen: - type: string + data: + $ref: '#/components/schemas/TemplatedPAComponent' + meta: + type: object required: - - screen + - data type: object - QuantDateList: - allOf: - - $ref: '#/components/schemas/QuantDate' + UnlinkedPATemplateParameters: + example: + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: + directory: + description: The directory to create an unlinked PA template + type: string + templateTypeId: + description: Template type id + type: string + description: + description: Template description + type: string + accounts: + description: List of accounts + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + columns: + description: List of columns for the PA calculation + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array dates: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation items: - type: string + $ref: '#/components/schemas/PACalculationGroup' type: array - type: object - QuantDate: - properties: - source: - enum: - - FdsDate - - DateList - type: string - frequency: + datasources: + $ref: '#/components/schemas/PACalculationDataSources' + currencyisocode: + description: Currency ISO code for calculation. type: string - calendar: + componentdetail: + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string - overrideUniversalScreenCalendar: - type: boolean + content: + $ref: '#/components/schemas/TemplateContentTypes' required: - - calendar - - frequency - - source + - directory + - templateTypeId type: object - QuantFdsDate: - allOf: - - $ref: '#/components/schemas/QuantDate' + UnlinkedPATemplateParametersRoot: + example: + data: + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: '{}' properties: - startDate: - type: string - endDate: - type: string + data: + $ref: '#/components/schemas/UnlinkedPATemplateParameters' + meta: + type: object required: - - endDate - - startDate + - data type: object - QuantFqlExpression: - allOf: - - $ref: '#/components/schemas/QuantFormula' + UnlinkedPATemplatePostSummary: + example: + name: name + description: description + id: id + category: category properties: - expr: + id: + description: Template id. + type: string + description: + description: Template description. type: string name: + description: Template name. type: string - dateOffset: + category: + description: Unlinked template category type: string - isArrayReturnType: - type: boolean + type: object + UnlinkedPATemplatePostSummaryRoot: + example: + data: + name: name + description: description + id: id + category: category + meta: '{}' + properties: + data: + $ref: '#/components/schemas/UnlinkedPATemplatePostSummary' + meta: + type: object required: - - expr - - name + - data type: object - QuantUniversalScreenParameter: - allOf: - - $ref: '#/components/schemas/QuantFormula' + UnlinkedPATemplateSummary: + example: + name: name + description: description + category: category properties: - referenceName: + description: + description: Template description. type: string name: + description: Template name. + type: string + category: + description: Unlinked template category type: string - required: - - name - - referenceName - type: object - QuantAllUniversalScreenParameters: - allOf: - - $ref: '#/components/schemas/QuantFormula' type: object - QuantFormula: + UnlinkedPATemplateSummaryRoot: + example: + data: + key: + name: name + description: description + category: category + meta: '{}' properties: - source: - enum: - - ScreeningExpression - - FqlExpression - - UniversalScreenParameter - - AllUniversalScreenParameters - type: string + data: + additionalProperties: + $ref: '#/components/schemas/UnlinkedPATemplateSummary' + type: object + meta: + type: object required: - - source + - data type: object - QuantScreeningExpression: - allOf: - - $ref: '#/components/schemas/QuantFormula' + UnlinkedPATemplateUpdateParameters: + example: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - expr: + description: + description: Template description type: string - name: + accounts: + description: List of accounts + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + columns: + description: List of columns for the PA calculation + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array + dates: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation + items: + $ref: '#/components/schemas/PACalculationGroup' + type: array + datasources: + $ref: '#/components/schemas/PACalculationDataSources' + currencyisocode: + description: Currency ISO code for calculation. type: string - dateOffset: + componentdetail: + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' + type: object + UnlinkedPATemplateUpdateParametersRoot: + example: + data: + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: '{}' + properties: + data: + $ref: '#/components/schemas/UnlinkedPATemplateUpdateParameters' + meta: + type: object required: - - expr - - name + - data type: object - OneOfQuantUniverse: - discriminator: - mapping: - UniversalScreenUniverse: '#/components/schemas/QuantUniversalScreenUniverse' - ScreeningExpressionUniverse: '#/components/schemas/QuantScreeningExpressionUniverse' - IdentifierUniverse: '#/components/schemas/QuantIdentifierUniverse' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantUniversalScreenUniverse' - - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' - - $ref: '#/components/schemas/QuantIdentifierUniverse' - OneOfQuantDates: - discriminator: - mapping: - FdsDate: '#/components/schemas/QuantFdsDate' - DateList: '#/components/schemas/QuantDateList' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantFdsDate' - - $ref: '#/components/schemas/QuantDateList' - OneOfQuantFormulas: - discriminator: - mapping: - ScreeningExpression: '#/components/schemas/QuantScreeningExpression' - FqlExpression: '#/components/schemas/QuantFqlExpression' - UniversalScreenParameter: '#/components/schemas/QuantUniversalScreenParameter' - AllUniversalScreenParameters: '#/components/schemas/QuantAllUniversalScreenParameters' - propertyName: source - oneOf: - - $ref: '#/components/schemas/QuantScreeningExpression' - - $ref: '#/components/schemas/QuantFqlExpression' - - $ref: '#/components/schemas/QuantUniversalScreenParameter' - - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' - OneOfQuantFormulasArray: - items: - $ref: '#/components/schemas/OneOfQuantFormulas' - type: array - QuantCalculationParameters: + UnlinkedPATemplate: example: - formulas: - - null - - null - jobDescription: jobDescription + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + description: description + dates: + enddate: enddate + startdate: startdate + frequency: frequency + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + name: name + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true properties: - universe: - $ref: '#/components/schemas/OneOfQuantUniverse' + id: + description: Template id. + type: string + directory: + description: Template directory. + type: string + templateTypeId: + description: Template type id + type: string + snapshot: + description: snapshot. + type: boolean + accounts: + description: List of accounts + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + columns: + description: List of columns for the PA calculation + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array dates: - $ref: '#/components/schemas/OneOfQuantDates' - formulas: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation items: - $ref: '#/components/schemas/OneOfQuantFormulas' + $ref: '#/components/schemas/PACalculationGroup' type: array - jobDescription: + datasources: + $ref: '#/components/schemas/PACalculationDataSources' + currencyisocode: + description: Currency ISO code for calculation. + type: string + componentdetail: + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. + type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' + description: + description: Template description. + type: string + name: + description: Template name. + type: string + category: + description: Unlinked template category type: string type: object - QuantCalculationMeta: + UnlinkedPATemplateRoot: example: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + data: + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + frequency: frequency + - id: id + frequency: frequency + description: description + dates: + enddate: enddate + startdate: startdate + frequency: frequency + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + datasources: + benchmarkpricingsources: + - id: id + - id: id + useportfoliopricingsourcesforbenchmark: true + portfoliopricingsources: + - id: id + - id: id + name: name + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + meta: '{}' properties: - allowArrayData: - type: boolean - contentorganization: - default: SimplifiedRow - deprecated: true - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - stachContentOrganization: - default: SimplifiedRow - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - contenttype: - default: Json - deprecated: true - enum: - - Json - - Binary + data: + $ref: '#/components/schemas/UnlinkedPATemplate' + meta: + type: object + required: + - data + type: object + UnlinkedPATemplateCategoryAndType: + example: + name: name + category: category + properties: + category: + description: Unlinked template category type: string - format: - default: JsonStach - enum: - - JsonStach - - Table - - Tableau - - BinaryStach - - Bison - - Binary - - Pdf - - Pptx - - Feather + name: + description: Unlinked template type type: string type: object - QuantCalculationParametersRoot: + UnlinkedPATemplateCategoryAndTypeRoot: example: data: key: - formulas: - - null - - null - jobDescription: jobDescription - meta: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + name: name + category: category + meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/QuantCalculationParameters' - description: List of calculation parameters. + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndType' type: object meta: - $ref: '#/components/schemas/QuantCalculationMeta' + type: object + required: + - data type: object - SPARDateParameters: - description: The date parameters for SPAR calculation. + UnlinkedPATemplateColumnDetails: example: - enddate: enddate - startdate: startdate - useeachportfolioinception: true + name: name + id: id + statistics: + - statistics + - statistics + properties: + name: + description: Unlinked template column name + type: string + id: + description: FactSet-defined or User-defined Column identifier. + type: string + statistics: + description: Column Statistic identifier + items: + type: string + type: array + type: object + UnlinkedPATemplateGroupDetails: + example: + name: name + id: id frequency: frequency properties: - startdate: - description: Calculation's start date. + name: + description: Unlinked template group name type: string - enddate: - description: Calculation's end date. + id: + description: FactSet-defined or User-defined Group identifier. type: string frequency: - description: Calculation's frequency. + description: Grouping frequency type: string - useeachportfolioinception: - description: Use Each Portfolio Inception - type: boolean - required: - - enddate - - frequency - - startdate type: object - SPARCalculationParameters: + UnlinkedPATemplateCategoryAndTypeDetails: example: - currencyisocode: currencyisocode - componentid: componentid - dates: - enddate: enddate - startdate: startdate - useeachportfolioinception: true - frequency: frequency - accounts: - - prefix: prefix - returntype: returntype + columns: + - name: name id: id - - prefix: prefix - returntype: returntype + statistics: + - statistics + - statistics + - name: name id: id - benchmark: - prefix: prefix - returntype: returntype + statistics: + - statistics + - statistics + name: name + groups: + - name: name + id: id + frequency: frequency + - name: name id: id + frequency: frequency + id: id + category: category + snapshot: true properties: - componentid: - description: The SPAR Engine component identifier to analyze. + id: + description: Type Id type: string - accounts: - description: List of accounts for SPAR calculation. + columns: + description: List of default columns items: - $ref: '#/components/schemas/SPARIdentifier' + $ref: '#/components/schemas/UnlinkedPATemplateColumnDetails' type: array - benchmark: - $ref: '#/components/schemas/SPARIdentifier' - dates: - $ref: '#/components/schemas/SPARDateParameters' - currencyisocode: - description: Currency ISO code for calculation. + groups: + description: List of default groupings + items: + $ref: '#/components/schemas/UnlinkedPATemplateGroupDetails' + type: array + snapshot: + description: Snapshot + type: boolean + category: + description: Unlinked template category + type: string + name: + description: Unlinked template type type: string - required: - - componentid type: object - SPARCalculationParametersRoot: + UnlinkedPATemplateCategoryAndTypeDetailsRoot: example: data: - key: - currencyisocode: currencyisocode - componentid: componentid - dates: - enddate: enddate - startdate: startdate - useeachportfolioinception: true - frequency: frequency - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmark: - prefix: prefix - returntype: returntype - id: id - meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + columns: + - name: name + id: id + statistics: + - statistics + - statistics + - name: name + id: id + statistics: + - statistics + - statistics + name: name + groups: + - name: name + id: id + frequency: frequency + - name: name + id: id + frequency: frequency + id: id + category: category + snapshot: true + meta: '{}' properties: data: - additionalProperties: - $ref: '#/components/schemas/SPARCalculationParameters' - description: List of calculation parameters. - type: object + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails' meta: - $ref: '#/components/schemas/CalculationMeta' + type: object + required: + - data type: object VaultAttributionLoaderResponse: example: diff --git a/auto-generated-sdk/docs/Column.md b/auto-generated-sdk/docs/Column.md new file mode 100644 index 00000000..ce244f69 --- /dev/null +++ b/auto-generated-sdk/docs/Column.md @@ -0,0 +1,20 @@ + + +# Column + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultstatisticsids** | **java.util.List<String>** | Column statistic Id | [optional] +**name** | **String** | Column Name | [optional] +**directory** | **String** | Column Directory | [optional] +**category** | **String** | Column Category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnRoot.md b/auto-generated-sdk/docs/ColumnRoot.md new file mode 100644 index 00000000..ee5ed73f --- /dev/null +++ b/auto-generated-sdk/docs/ColumnRoot.md @@ -0,0 +1,18 @@ + + +# ColumnRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Column**](Column.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnStatistic.md b/auto-generated-sdk/docs/ColumnStatistic.md new file mode 100644 index 00000000..84b24998 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatistic.md @@ -0,0 +1,17 @@ + + +# ColumnStatistic + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Column Statistic Name | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnStatisticRoot.md b/auto-generated-sdk/docs/ColumnStatisticRoot.md new file mode 100644 index 00000000..db736da9 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatisticRoot.md @@ -0,0 +1,18 @@ + + +# ColumnStatisticRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, ColumnStatistic>**](ColumnStatistic.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnStatisticsApi.md b/auto-generated-sdk/docs/ColumnStatisticsApi.md new file mode 100644 index 00000000..e9e4c14a --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatisticsApi.md @@ -0,0 +1,87 @@ + +# ColumnStatisticsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPAColumnStatistics**](ColumnStatisticsApi.md#getPAColumnStatistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics + + + +## getPAColumnStatistics + +> ColumnStatisticRoot getPAColumnStatistics() + +Get PA column statistics + +This endpoint lists all the column statistics that can be applied to a PA column. + +### 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.ColumnStatisticsApi; + +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"); + + ColumnStatisticsApi apiInstance = new ColumnStatisticsApi(defaultClient); + try { + ColumnStatisticRoot result = apiInstance.getPAColumnStatistics(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ColumnStatisticsApi#getPAColumnStatistics"); + 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 + +[**ColumnStatisticRoot**](ColumnStatisticRoot.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 PA column statistics | * 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/ColumnSummary.md b/auto-generated-sdk/docs/ColumnSummary.md new file mode 100644 index 00000000..7c52dab2 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnSummary.md @@ -0,0 +1,20 @@ + + +# ColumnSummary + +Column settings (name, directory, category) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Column Name | [optional] +**directory** | **String** | Column Directory | [optional] +**category** | **String** | Column Category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnSummaryRoot.md b/auto-generated-sdk/docs/ColumnSummaryRoot.md new file mode 100644 index 00000000..b038c090 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnSummaryRoot.md @@ -0,0 +1,18 @@ + + +# ColumnSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, ColumnSummary>**](ColumnSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md new file mode 100644 index 00000000..29a80a14 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnsApi.md @@ -0,0 +1,179 @@ + +# ColumnsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPAColumnById**](ColumnsApi.md#getPAColumnById) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings +[**getPAColumns**](ColumnsApi.md#getPAColumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns + + + +## getPAColumnById + +> ColumnRoot getPAColumnById(id) + +Get PA column settings + +This endpoint returns the default settings of a PA column. + +### 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.ColumnsApi; + +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"); + + ColumnsApi apiInstance = new ColumnsApi(defaultClient); + String id = "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7"; // String | Unique identifier for a column + try { + ColumnRoot result = apiInstance.getPAColumnById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ColumnsApi#getPAColumnById"); + 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**| Unique identifier for a column | + +### Return type + +[**ColumnRoot**](ColumnRoot.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 settings of a PA column. | * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. | * 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** | Column 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.
| + + +## getPAColumns + +> ColumnSummaryRoot getPAColumns(name, category, directory) + +Get PA columns + +This endpoint lists all the PA columns that can be applied to 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.ColumnsApi; + +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"); + + ColumnsApi apiInstance = new ColumnsApi(defaultClient); + String name = ""; // String | Column name + String category = ""; // String | Column category + String directory = ""; // String | The directory to get the columns in + try { + ColumnSummaryRoot result = apiInstance.getPAColumns(name, category, directory); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ColumnsApi#getPAColumns"); + 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 +------------- | ------------- | ------------- | ------------- + **name** | **String**| Column name | [optional] [default to ] + **category** | **String**| Column category | [optional] [default to ] + **directory** | **String**| The directory to get the columns in | [optional] [default to ] + +### Return type + +[**ColumnSummaryRoot**](ColumnSummaryRoot.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 PA columns | * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index 7956eb0b..49881302 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -5,6 +5,8 @@ All URIs are relative to *https://api.factset.com* 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 [**getSPARComponentById**](ComponentsApi.md#getSPARComponentById) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id [**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 @@ -12,6 +14,172 @@ Method | HTTP request | Description +## getPAComponentById + +> PAComponentRoot getPAComponentById(id) + +Get PA component by id + +This endpoint returns the default settings of a PA component. + +### 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 id = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Unique identifier for a PA component + try { + PAComponentRoot result = apiInstance.getPAComponentById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ComponentsApi#getPAComponentById"); + 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**| Unique identifier for a PA component | + +### Return type + +[**PAComponentRoot**](PAComponentRoot.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 default settings of a PA component. | * 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 PA component id. | * 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** | Component 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.
| + + +## getPAComponents + +> ComponentSummaryRoot getPAComponents(document) + +Get PA components + +This endpoint returns the list of PA components in a given PA 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 = "PA3_DOCUMENTS:DEFAULT"; // String | Document Name + try { + ComponentSummaryRoot result = apiInstance.getPAComponents(document); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ComponentsApi#getPAComponents"); + 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 PA 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 PA 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** | 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.
| + + ## getSPARComponentById > SPARComponentRoot getSPARComponentById(id) diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index 6a1d5a47..e7653abe 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -5,11 +5,94 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**getPACommentaryConfigurations**](ConfigurationsApi.md#getPACommentaryConfigurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory [**getVaultConfigurationById**](ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id [**getVaultConfigurations**](ConfigurationsApi.md#getVaultConfigurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations +## getPACommentaryConfigurations + +> PACommentaryConfigurationSummaryRoot getPACommentaryConfigurations(path) + +Get PA commentary configurations in a directory + +This endpoint returns all PA commentary configurations 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.ConfigurationsApi; + +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"); + + ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); + String path = "Client:"; // String | The directory to get the PA commentary configurations + try { + PACommentaryConfigurationSummaryRoot result = apiInstance.getPACommentaryConfigurations(path); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationsApi#getPACommentaryConfigurations"); + 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 PA commentary configurations | + +### Return type + +[**PACommentaryConfigurationSummaryRoot**](PACommentaryConfigurationSummaryRoot.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 map of configuration ID to PA commentary configuration | * 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 path 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.
| +| **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.
| + + ## getVaultConfigurationById > VaultConfigurationRoot getVaultConfigurationById(id) diff --git a/auto-generated-sdk/docs/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md index 3757dca7..95a53ec2 100644 --- a/auto-generated-sdk/docs/DatesApi.md +++ b/auto-generated-sdk/docs/DatesApi.md @@ -5,10 +5,100 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**convertPADatesToAbsoluteFormat**](DatesApi.md#convertPADatesToAbsoluteFormat) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format [**convertVaultDatesToAbsoluteFormat**](DatesApi.md#convertVaultDatesToAbsoluteFormat) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format +## convertPADatesToAbsoluteFormat + +> DateParametersSummaryRoot convertPADatesToAbsoluteFormat(enddate, componentid, account, startdate) + +Convert PA dates to absolute format + +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. + +### 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.DatesApi; + +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"); + + DatesApi apiInstance = new DatesApi(defaultClient); + String enddate = "-1AY"; // String | End Date + String componentid = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Component Id + String account = "Client:/Folder1/Folder2/AccountName.ACCT"; // String | Account ( Account Name ending with .ACCT or .ACTM ) + String startdate = "-3AY"; // String | Start Date + try { + DateParametersSummaryRoot result = apiInstance.convertPADatesToAbsoluteFormat(enddate, componentid, account, startdate); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DatesApi#convertPADatesToAbsoluteFormat"); + 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 +------------- | ------------- | ------------- | ------------- + **enddate** | **String**| End Date | + **componentid** | **String**| Component Id | + **account** | **String**| Account ( Account Name ending with .ACCT or .ACTM ) | + **startdate** | **String**| Start Date | [optional] + +### Return type + +[**DateParametersSummaryRoot**](DateParametersSummaryRoot.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 converted dates in yyyymmdd format. | * 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 is 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** | Document or 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.
| + + ## convertVaultDatesToAbsoluteFormat > DateParametersSummaryRoot convertVaultDatesToAbsoluteFormat(enddate, componentid, account, startdate) diff --git a/auto-generated-sdk/docs/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md index dd03bb06..ddf6de1b 100644 --- a/auto-generated-sdk/docs/DocumentsApi.md +++ b/auto-generated-sdk/docs/DocumentsApi.md @@ -5,12 +5,96 @@ All URIs are relative to *https://api.factset.com* 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 +## getPA3Documents + +> DocumentDirectoriesRoot getPA3Documents(path) + +Get PA3 documents and sub-directories in a directory + +This endpoint looks up all PA3 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 = "Client:"; // String | The directory to get the documents and sub-directories in + try { + DocumentDirectoriesRoot result = apiInstance.getPA3Documents(path); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DocumentsApi#getPA3Documents"); + 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 and sub-directories in | + +### 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 PA3 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.
| + + ## getPubDocuments > DocumentDirectoriesRoot getPubDocuments(path) diff --git a/auto-generated-sdk/docs/FPOAccount.md b/auto-generated-sdk/docs/FPOAccount.md new file mode 100644 index 00000000..9b05baf9 --- /dev/null +++ b/auto-generated-sdk/docs/FPOAccount.md @@ -0,0 +1,19 @@ + + +# FPOAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paDocument** | [**PaDoc**](PaDoc.md) | | +**id** | **String** | Account path | [optional] +**overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOObjective.md b/auto-generated-sdk/docs/FPOObjective.md new file mode 100644 index 00000000..24143e54 --- /dev/null +++ b/auto-generated-sdk/docs/FPOObjective.md @@ -0,0 +1,27 @@ + + +# FPOObjective + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **String** | | [optional] +**terms** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | | [optional] + + + +## Enum: java.util.Map<String, InnerEnum> + +Name | Value +---- | ----- +DISABLE | "Disable" +ENABLE | "Enable" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOOptimizationParameters.md b/auto-generated-sdk/docs/FPOOptimizationParameters.md new file mode 100644 index 00000000..27f06e93 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizationParameters.md @@ -0,0 +1,20 @@ + + +# FPOOptimizationParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | [**FPOAccount**](FPOAccount.md) | | [optional] +**strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | +**optimization** | [**Optimization**](Optimization.md) | | [optional] +**outputTypes** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md new file mode 100644 index 00000000..564822d0 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md @@ -0,0 +1,18 @@ + + +# FPOOptimizationParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**FPOOptimizationParameters**](FPOOptimizationParameters.md) | | [optional] +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategy.md b/auto-generated-sdk/docs/FPOOptimizerStrategy.md new file mode 100644 index 00000000..1ad0218d --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizerStrategy.md @@ -0,0 +1,18 @@ + + +# FPOOptimizerStrategy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] +**id** | **String** | OptimizerStrategy document path | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md new file mode 100644 index 00000000..74b1557a --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md @@ -0,0 +1,29 @@ + + +# FPOOptimizerStrategyOverrides + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objective** | [**FPOObjective**](FPOObjective.md) | | [optional] +**constraints** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | List of constraints | [optional] +**alpha** | **String** | Alpha | [optional] +**transactionCost** | **String** | Transaction cost | [optional] + + + +## Enum: java.util.Map<String, InnerEnum> + +Name | Value +---- | ----- +DISABLE | "Disable" +ENABLE | "Enable" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FpoOptimizerApi.md b/auto-generated-sdk/docs/FpoOptimizerApi.md new file mode 100644 index 00000000..74852448 --- /dev/null +++ b/auto-generated-sdk/docs/FpoOptimizerApi.md @@ -0,0 +1,527 @@ + +# FpoOptimizerApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelOptimizationById**](FpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id +[**getOptimizationParameters**](FpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id +[**getOptimizationResult**](FpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id +[**getOptimizationStatusById**](FpoOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id +[**postAndOptimize**](FpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization +[**putAndOptimize**](FpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. + + + +## cancelOptimizationById + +> cancelOptimizationById(id) + +Cancel FPO optimization by id + +This is the endpoint to cancel a previously submitted optimization. + +### 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint + try { + apiInstance.cancelOptimizationById(id); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#cancelOptimizationById"); + 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 FPO optimization 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, optimization 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 optimization 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.
| + + +## getOptimizationParameters + +> FPOOptimizationParametersRoot getOptimizationParameters(id) + +Get FPO optimization parameters by id + +This is the endpoint that returns the optimization parameters passed for an optimization. + +### 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint + try { + FPOOptimizationParametersRoot result = apiInstance.getOptimizationParameters(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#getOptimizationParameters"); + 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 FPO optimization endpoint | + +### Return type + +[**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.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 FPO optimization 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** | Optimization 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.
| + + +## getOptimizationResult + +> ObjectRoot getOptimizationResult(id, accept) + +Get FPO optimization result by id + +This is the endpoint to get the result of a previously requested optimization. +If the optimization has finished computing, the body of the response will contain result 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Get FPO optimization status by id endpoint + String accept = "accept_example"; // String | Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * + try { + ObjectRoot result = apiInstance.getOptimizationResult(id, accept); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#getOptimizationResult"); + 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 FPO optimization status by id endpoint | + **accept** | **String**| Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * | [optional] + +### Return type + +[**ObjectRoot**](ObjectRoot.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 optimization is completed, returns JSON. | * 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** | Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
| + + +## getOptimizationStatusById + +> ObjectRoot getOptimizationStatusById(id) + +Get FPO optimization status by id + +This is the endpoint to check on the progress of a previously requested optimization. +If the optimization has finished computing, the body of the response will contain result in JSON. +Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint + try { + Object result = apiInstance.getOptimizationStatusById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#getOptimizationStatusById"); + 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 FPO optimization endpoint | + +### Return type + +(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - null (empty response body) ) + +### 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 | +|-------------|-------------|------------------| +| **201** | Expected response once optimization is completed, returns 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.
| +| **202** | Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * 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** | Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
| + + +## postAndOptimize + +> ObjectRoot postAndOptimize(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot) + +Create and Run FPO optimization + +This endpoint runs FPO optimization specified in the POST body parameters. + +Remarks: + +* Any settings in POST body will act as a one-time override over the settings saved in the strategy 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. + String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. + FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters + try { + Object result = apiInstance.postAndOptimize(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#postAndOptimize"); + 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. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] + **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] + +### Return type + +(For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.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 + +### 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 optimization
* 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, returns json if optimization is completed in a short span. | * 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 optimization 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 optimization 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 optimization 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.
| + + +## putAndOptimize + +> ObjectRoot putAndOptimize(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot) + +Create or Update FPO optimization and run it. + +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. + +### 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.FpoOptimizerApi; + +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"); + + FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint + Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. + String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. + FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters + try { + Object result = apiInstance.putAndOptimize(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FpoOptimizerApi#putAndOptimize"); + 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 FPO optimization endpoint | + **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] + **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] + +### Return type + +(For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.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 + +### 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 optimization
* 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, returns json if optimization is completed in a short span. | * 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 Optimization 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 optimization 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 optimization 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 optimization 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/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md index f26d622a..3a93493a 100644 --- a/auto-generated-sdk/docs/FrequenciesApi.md +++ b/auto-generated-sdk/docs/FrequenciesApi.md @@ -5,11 +5,89 @@ 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 +## getPAFrequencies + +> FrequencyRoot getPAFrequencies() + +Get PA frequencies + +This endpoint lists all the frequencies that can be applied to a PA 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.getPAFrequencies(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FrequenciesApi#getPAFrequencies"); + 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 PA 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.
| + + ## getSPARFrequencies > FrequencyRoot getSPARFrequencies() diff --git a/auto-generated-sdk/docs/Group.md b/auto-generated-sdk/docs/Group.md new file mode 100644 index 00000000..58529bbf --- /dev/null +++ b/auto-generated-sdk/docs/Group.md @@ -0,0 +1,19 @@ + + +# Group + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Group Name | [optional] +**directory** | **String** | Group Directory | [optional] +**category** | **String** | Group Category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/GroupRoot.md b/auto-generated-sdk/docs/GroupRoot.md new file mode 100644 index 00000000..cf84e286 --- /dev/null +++ b/auto-generated-sdk/docs/GroupRoot.md @@ -0,0 +1,18 @@ + + +# GroupRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, Group>**](Group.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/GroupsApi.md b/auto-generated-sdk/docs/GroupsApi.md new file mode 100644 index 00000000..6e135ada --- /dev/null +++ b/auto-generated-sdk/docs/GroupsApi.md @@ -0,0 +1,165 @@ + +# GroupsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPAGroupingFrequencies**](GroupsApi.md#getPAGroupingFrequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies +[**getPAGroups**](GroupsApi.md#getPAGroups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups + + + +## getPAGroupingFrequencies + +> FrequencyRoot getPAGroupingFrequencies() + +Get PA grouping frequencies + +This endpoint lists all the PA grouping frequencies that can be applied to a PA 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.GroupsApi; + +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"); + + GroupsApi apiInstance = new GroupsApi(defaultClient); + try { + FrequencyRoot result = apiInstance.getPAGroupingFrequencies(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling GroupsApi#getPAGroupingFrequencies"); + 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 PA grouping 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.
| + + +## getPAGroups + +> GroupRoot getPAGroups() + +Get PA groups + +This endpoint lists all the PA groups that can be applied to a PA 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.GroupsApi; + +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"); + + GroupsApi apiInstance = new GroupsApi(defaultClient); + try { + GroupRoot result = apiInstance.getPAGroups(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling GroupsApi#getPAGroups"); + 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 + +[**GroupRoot**](GroupRoot.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 PA groups | * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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/LinkedPATemplate.md b/auto-generated-sdk/docs/LinkedPATemplate.md new file mode 100644 index 00000000..fe80a3c2 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplate.md @@ -0,0 +1,23 @@ + + +# LinkedPATemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | Template directory. | [optional] +**snapshot** | **Boolean** | snapshot. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateParameters.md new file mode 100644 index 00000000..c4049aa8 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParameters.md @@ -0,0 +1,20 @@ + + +# LinkedPATemplateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | The directory to create a linked PA template | +**parentComponentId** | **String** | Parent component id | +**description** | **String** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..498eb6db --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md new file mode 100644 index 00000000..516b8a6f --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md @@ -0,0 +1,20 @@ + + +# LinkedPATemplatePostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..ab14f6c4 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplatePostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateRoot.md b/auto-generated-sdk/docs/LinkedPATemplateRoot.md new file mode 100644 index 00000000..f9cac34a --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummary.md b/auto-generated-sdk/docs/LinkedPATemplateSummary.md new file mode 100644 index 00000000..8e95e61f --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummary.md @@ -0,0 +1,19 @@ + + +# LinkedPATemplateSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..a75c2ba8 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, LinkedPATemplateSummary>**](LinkedPATemplateSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..61862c91 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md @@ -0,0 +1,19 @@ + + +# LinkedPATemplateUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parentComponentId** | **String** | Parent component id | [optional] +**description** | **String** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..b0fdc1fb --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md new file mode 100644 index 00000000..7318bc56 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md @@ -0,0 +1,460 @@ + +# LinkedPaTemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createLinkedPATemplates**](LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +[**deleteLinkedPATemplates**](LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +[**getLinkedPATemplates**](LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +[**getLinkedPATemplatesById**](LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +[**updateLinkedPATemplates**](LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template + + + +## createLinkedPATemplates + +> LinkedPATemplatePostSummaryRoot createLinkedPATemplates(linkedPATemplateParametersRoot) + +Create a linked PA template + +This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. + +Remarks: + +* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. + If no mandatory fields are passed, then we can use the template as a component and skip the component creation. + +* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Multi-horizon frequencies are not supported through this endpoint. + +### 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.LinkedPaTemplatesApi; + +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"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = new LinkedPATemplateParametersRoot(); // LinkedPATemplateParametersRoot | Request Parameters + try { + LinkedPATemplatePostSummaryRoot result = apiInstance.createLinkedPATemplates(linkedPATemplateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#createLinkedPATemplates"); + 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 +------------- | ------------- | ------------- | ------------- + **linkedPATemplateParametersRoot** | [**LinkedPATemplateParametersRoot**](LinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + +[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.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 | +|-------------|-------------|------------------| +| **201** | Expected response, created a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| +| **404** | Component 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.
| +| **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.
| + + +## deleteLinkedPATemplates + +> deleteLinkedPATemplates(id) + +Delete a linked PA template. + +This endpoint deletes an existing linked PA 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.LinkedPaTemplatesApi; + +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"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template + try { + apiInstance.deleteLinkedPATemplates(id); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#deleteLinkedPATemplates"); + 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**| Unique identifier for a linked PA template | + +### Return type + +null (empty response body) + +### 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 | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## getLinkedPATemplates + +> LinkedPATemplateSummaryRoot getLinkedPATemplates(directory, documentDirectory, documentName) + +Get linked PA templates + +This endpoint returns the list of linked PA templates in given path. + +### 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.LinkedPaTemplatesApi; + +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"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + 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 { + LinkedPATemplateSummaryRoot result = apiInstance.getLinkedPATemplates(directory, documentDirectory, documentName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplates"); + 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 +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get linked PA templates in path. | [optional] + **documentDirectory** | **String**| Get linked PA templates for documents in document path | [optional] + **documentName** | **String**| Get linked PA templates for documents by document name | [optional] + +### Return type + +[**LinkedPATemplateSummaryRoot**](LinkedPATemplateSummaryRoot.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 templates linked to PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | 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.
| + + +## getLinkedPATemplatesById + +> LinkedPATemplateRoot getLinkedPATemplatesById(id) + +Get linked PA template by id + +This endpoint fetches the linked PA template settings. + +### 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.LinkedPaTemplatesApi; + +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"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template + try { + LinkedPATemplateRoot result = apiInstance.getLinkedPATemplatesById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplatesById"); + 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**| Unique identifier for a linked PA template | + +### Return type + +[**LinkedPATemplateRoot**](LinkedPATemplateRoot.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, linked PA template details. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## updateLinkedPATemplates + +> LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot) + +Update a linked PA template + +This endpoint allows the user to change the request body and description from an existing template. + +Remarks: + +* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. + If no mandatory fields are passed, then we can use the template as a component and skip the component creation. + +* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Multi-horizon frequencies are not supported through this endpoint. + +### 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.LinkedPaTemplatesApi; + +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"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + 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); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#updateLinkedPATemplates"); + 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**| Unique identifier for a linked PA template | + **linkedPATemplateUpdateParametersRoot** | [**LinkedPATemplateUpdateParametersRoot**](LinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.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, updated a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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 or component 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/Metadata.md b/auto-generated-sdk/docs/Metadata.md new file mode 100644 index 00000000..2384faca --- /dev/null +++ b/auto-generated-sdk/docs/Metadata.md @@ -0,0 +1,22 @@ + + +# Metadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tileName** | **String** | PA Tile name associated with the component | [optional] +**portfolioDescription** | **String** | Portfolio name used in generating commentary | [optional] +**benchmarkDescription** | **String** | Benchmark name used in generating commentary | [optional] +**startDate** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] +**endDate** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] +**frequency** | **String** | Date frequency | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationColumn.md b/auto-generated-sdk/docs/PACalculationColumn.md new file mode 100644 index 00000000..7fe7461d --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationColumn.md @@ -0,0 +1,18 @@ + + +# PACalculationColumn + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | FactSet-defined or User-defined Column identifier. | [optional] +**statistics** | **java.util.List<String>** | Column Statistic identifier | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationDataSources.md b/auto-generated-sdk/docs/PACalculationDataSources.md new file mode 100644 index 00000000..96549eae --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationDataSources.md @@ -0,0 +1,19 @@ + + +# PACalculationDataSources + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**portfoliopricingsources** | [**java.util.List<PACalculationPricingSource>**](PACalculationPricingSource.md) | List of portfilio pricing source for the PA calculation | [optional] +**benchmarkpricingsources** | [**java.util.List<PACalculationPricingSource>**](PACalculationPricingSource.md) | List of benchmark pricing source for the PA calculation | [optional] +**useportfoliopricingsourcesforbenchmark** | **Boolean** | Use portfolio pricing sources for benchmark | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationGroup.md b/auto-generated-sdk/docs/PACalculationGroup.md new file mode 100644 index 00000000..c1a2297a --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationGroup.md @@ -0,0 +1,18 @@ + + +# PACalculationGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | FactSet-defined or User-defined Group identifier. | [optional] +**frequency** | **String** | Grouping frequency | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md new file mode 100644 index 00000000..35dfd1e6 --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationParameters.md @@ -0,0 +1,25 @@ + + +# PACalculationParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**componentid** | **String** | The PA Engine component identifier to analyze. | +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks. | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**componentdetail** | **String** | Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationParametersRoot.md b/auto-generated-sdk/docs/PACalculationParametersRoot.md new file mode 100644 index 00000000..ce6d7e1b --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationParametersRoot.md @@ -0,0 +1,18 @@ + + +# PACalculationParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, PACalculationParameters>**](PACalculationParameters.md) | List of calculation parameters. | [optional] +**meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACalculationPricingSource.md b/auto-generated-sdk/docs/PACalculationPricingSource.md new file mode 100644 index 00000000..b196e20e --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationPricingSource.md @@ -0,0 +1,17 @@ + + +# PACalculationPricingSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Pricing source identifier | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentary.md b/auto-generated-sdk/docs/PACommentary.md new file mode 100644 index 00000000..b5d0425f --- /dev/null +++ b/auto-generated-sdk/docs/PACommentary.md @@ -0,0 +1,19 @@ + + +# PACommentary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentaryId** | **String** | Generated commentary Id | [optional] +**sections** | [**java.util.List<Section>**](Section.md) | Commentary sections | [optional] +**disclaimer** | **String** | Disclaimer | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md new file mode 100644 index 00000000..6db2df86 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md @@ -0,0 +1,18 @@ + + +# PACommentaryConfigurationSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | PA commentary configuration name | [optional] +**directory** | **String** | PA Commentary configuration directory | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md new file mode 100644 index 00000000..f17234b9 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md @@ -0,0 +1,18 @@ + + +# PACommentaryConfigurationSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, PACommentaryConfigurationSummary>**](PACommentaryConfigurationSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryDate.md b/auto-generated-sdk/docs/PACommentaryDate.md new file mode 100644 index 00000000..ed8f20f4 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryDate.md @@ -0,0 +1,18 @@ + + +# PACommentaryDate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**yyyymmdd** | **Integer** | Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. | [optional] +**relative** | **String** | Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryGetStatus.md b/auto-generated-sdk/docs/PACommentaryGetStatus.md new file mode 100644 index 00000000..e190118a --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryGetStatus.md @@ -0,0 +1,28 @@ + + +# PACommentaryGetStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**calculationid** | **String** | Calculation id. | [optional] +**unitid** | **String** | Calculation unit id. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The status of commentary generation. | [optional] + + + +## Enum: StatusEnum + +Name | Value +---- | ----- +EXECUTING | "Executing" +SUCCESS | "Success" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md b/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md new file mode 100644 index 00000000..2cc1db71 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md @@ -0,0 +1,18 @@ + + +# PACommentaryGetStatusRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryGetStatus**](PACommentaryGetStatus.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryParameters.md b/auto-generated-sdk/docs/PACommentaryParameters.md new file mode 100644 index 00000000..f8de00cd --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryParameters.md @@ -0,0 +1,17 @@ + + +# PACommentaryParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configurationid** | **String** | Commentary configuration id | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryParametersRoot.md b/auto-generated-sdk/docs/PACommentaryParametersRoot.md new file mode 100644 index 00000000..a5a98ab4 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryParametersRoot.md @@ -0,0 +1,18 @@ + + +# PACommentaryParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryParameters**](PACommentaryParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryRoot.md b/auto-generated-sdk/docs/PACommentaryRoot.md new file mode 100644 index 00000000..3ab6cd91 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryRoot.md @@ -0,0 +1,18 @@ + + +# PACommentaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentary**](PACommentary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryStatus.md b/auto-generated-sdk/docs/PACommentaryStatus.md new file mode 100644 index 00000000..9ddac8ab --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryStatus.md @@ -0,0 +1,29 @@ + + +# PACommentaryStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | **String** | The result url of the generated commentary. | [optional] +**calculationid** | **String** | Calculation id. | [optional] +**unitid** | **String** | Calculation unit id. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The status of commentary generation. | [optional] + + + +## Enum: StatusEnum + +Name | Value +---- | ----- +EXECUTING | "Executing" +SUCCESS | "Success" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryStatusRoot.md b/auto-generated-sdk/docs/PACommentaryStatusRoot.md new file mode 100644 index 00000000..06b48ebe --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryStatusRoot.md @@ -0,0 +1,18 @@ + + +# PACommentaryStatusRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryStatus**](PACommentaryStatus.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md new file mode 100644 index 00000000..df989d29 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponent.md @@ -0,0 +1,25 @@ + + +# PAComponent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Component identifier. | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] +**currencyisocode** | **String** | | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**snapshot** | **Boolean** | Is the component type snapshot or subperiod. | [optional] +**path** | **String** | The path to the document | [optional] +**name** | **String** | Component name. | [optional] +**category** | **String** | Component category. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md new file mode 100644 index 00000000..45f35d8e --- /dev/null +++ b/auto-generated-sdk/docs/PAComponentData.md @@ -0,0 +1,24 @@ + + +# PAComponentData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks. | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAComponentRoot.md b/auto-generated-sdk/docs/PAComponentRoot.md new file mode 100644 index 00000000..84e31c05 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponentRoot.md @@ -0,0 +1,18 @@ + + +# PAComponentRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PAComponent**](PAComponent.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PADateParameters.md b/auto-generated-sdk/docs/PADateParameters.md new file mode 100644 index 00000000..c73a5013 --- /dev/null +++ b/auto-generated-sdk/docs/PADateParameters.md @@ -0,0 +1,20 @@ + + +# PADateParameters + +The date parameters for PA calculation. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startdate** | **String** | Calculation's start date. | [optional] +**enddate** | **String** | Calculation's end date. | +**frequency** | **String** | Calculation's frequency. | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAIdentifier.md b/auto-generated-sdk/docs/PAIdentifier.md new file mode 100644 index 00000000..fc5a1c10 --- /dev/null +++ b/auto-generated-sdk/docs/PAIdentifier.md @@ -0,0 +1,18 @@ + + +# PAIdentifier + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | User's FactSet account path OR benchmark. | +**holdingsmode** | **String** | Holdings Mode can be B&H, TBR, OMS , EXT or VLT. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAPricingSource.md b/auto-generated-sdk/docs/PAPricingSource.md new file mode 100644 index 00000000..7fb89d43 --- /dev/null +++ b/auto-generated-sdk/docs/PAPricingSource.md @@ -0,0 +1,19 @@ + + +# PAPricingSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Pricing source Name | [optional] +**directory** | **String** | Pricing source directory | [optional] +**category** | **String** | Pricing source category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PAPricingSourceRoot.md b/auto-generated-sdk/docs/PAPricingSourceRoot.md new file mode 100644 index 00000000..df400d3f --- /dev/null +++ b/auto-generated-sdk/docs/PAPricingSourceRoot.md @@ -0,0 +1,18 @@ + + +# PAPricingSourceRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, PAPricingSource>**](PAPricingSource.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PaCalculationsApi.md b/auto-generated-sdk/docs/PaCalculationsApi.md new file mode 100644 index 00000000..782e3445 --- /dev/null +++ b/auto-generated-sdk/docs/PaCalculationsApi.md @@ -0,0 +1,920 @@ + +# PaCalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelCalculationById**](PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id +[**generatePAPortfolioCommentary**](PaCalculationsApi.md#generatePAPortfolioCommentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. +[**getAllCalculations**](PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations +[**getCalculationParameters**](PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id +[**getCalculationStatusById**](PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id +[**getCalculationUnitResultById**](PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id +[**getPAPortfolioCommentaryResultById**](PaCalculationsApi.md#getPAPortfolioCommentaryResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. +[**getPAPortfolioCommentaryStatusById**](PaCalculationsApi.md#getPAPortfolioCommentaryStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. +[**postAndCalculate**](PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation +[**putAndCalculate**](PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. + + + +## cancelCalculationById + +> cancelCalculationById(id) + +Cancel PA calculation by id + +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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint + try { + apiInstance.cancelCalculationById(id); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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 PA 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**: application/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.
| + + +## generatePAPortfolioCommentary + +> PACommentaryRoot generatePAPortfolioCommentary(id, unitId, paCommentaryParametersRoot) + +Generate PA portfolio commentary by calculation and unit id. + +This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. + +Remarks: + +* The PA component used in the calculation must be an attribution tile. + +* The "Variation in Average Weight" column must be included along with those required + as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) + in the component for successful commentary generation; otherwise, the request will result in an error. + +* PA portfolio commentary generation is not supported for multi-port requests. + +* The POST calculation must use a single portfolio and a benchmark to generate the commentary. + +* PA portfolio commentary with sub-period analysis will be returned only when the frequency + is set to something other than "single" and the report contains more than one sub-period. + +* Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. + If the configuration ID is not specified, the default commentary will be returned. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | Successful calculation id + String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id + PACommentaryParametersRoot paCommentaryParametersRoot = new PACommentaryParametersRoot(); // PACommentaryParametersRoot | Request Parameters + try { + Object result = apiInstance.generatePAPortfolioCommentary(id, unitId, paCommentaryParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#generatePAPortfolioCommentary"); + 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**| Successful calculation id | + **unitId** | **String**| Unit id associated with the successful calculation id | + **paCommentaryParametersRoot** | [**PACommentaryParametersRoot**](PACommentaryParametersRoot.md)| Request Parameters | [optional] + +### Return type + +(For 201 status - [**PACommentaryRoot**](PACommentaryRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.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 | +|-------------|-------------|------------------| +| **201** | Expected response if the commentary generation is completed in a short span, returns 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.
| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting commentary
* 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.
| +| **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. 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.
| + + +## 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + Integer pageNumber = 1; // Integer | + try { + CalculationsSummaryRoot result = apiInstance.getAllCalculations(pageNumber); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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**| | [optional] [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 + +> PACalculationParametersRoot getCalculationParameters(id) + +Get PA 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint + try { + PACalculationParametersRoot result = apiInstance.getCalculationParameters(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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 PA calculation endpoint | + +### Return type + +[**PACalculationParametersRoot**](PACalculationParametersRoot.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 PA 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 PA 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. +Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint + try { + CalculationStatusRoot result = apiInstance.getCalculationStatusById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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 PA 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, should contain X-FactSet-Api-PickUp-Progress header. | * 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 PA 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Get PA calculation status by id endpoint + String unitId = "unitId_example"; // String | from url, provided from the location header in the Get PA 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 PaCalculationsApi#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 PA calculation status by id endpoint | + **unitId** | **String**| from url, provided from the location header in the Get PA 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.
| + + +## getPAPortfolioCommentaryResultById + +> PACommentaryRoot getPAPortfolioCommentaryResultById(id, unitId) + +Get PA Portfolio commentary result by calculation and unit id. + +This endpoint retrieves the result of a previously requested portfolio commentary. +If the commentary generation is complete, the commentary will be returned in a predefined JSON format. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | Successful calculation id + String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id + try { + PACommentaryRoot result = apiInstance.getPAPortfolioCommentaryResultById(id, unitId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#getPAPortfolioCommentaryResultById"); + 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**| Successful calculation id | + **unitId** | **String**| Unit id associated with the successful calculation id | + +### Return type + +[**PACommentaryRoot**](PACommentaryRoot.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 the commentary generation is completed, returns JSON. | * 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.
| +| **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.
| + + +## getPAPortfolioCommentaryStatusById + +> PACommentaryStatusRoot getPAPortfolioCommentaryStatusById(id, unitId) + +Get PA portfolio commentary status by calculation and unit id. + +This endpoint allows you to check the progress of a previously requested PA portfolio commentary. +If the commentary generation is complete, the location header will provide the URL for the result. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | Successful calculation id + String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id + try { + Object result = apiInstance.getPAPortfolioCommentaryStatusById(id, unitId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#getPAPortfolioCommentaryStatusById"); + 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**| Successful calculation id | + **unitId** | **String**| Unit id associated with the successful calculation id | + +### Return type + +(For 200 status - [**PACommentaryStatusRoot**](PACommentaryStatusRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.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 commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * 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.
| +| **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, paCalculationParametersRoot) + +Create and Run PA calculation + +This endpoint runs the PA calculation specified in the POST body parameters. +It can take one or more calculation units as input. + +Remarks: + +* Any settings in POST body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding + the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. + String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. + PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters + try { + Object result = apiInstance.postAndCalculate(xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] + **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] + +### Return type + +(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.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.
| +| **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.
| +| **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.
| +| **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, paCalculationParametersRoot) + +Create or Update PA calculation and run it. + +This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. +It can take one or more calculation units as input. + +Remarks: + +* Any settings in PUT body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding + the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +### 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.PaCalculationsApi; + +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"); + + PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); + String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint + Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation + String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale. + PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters + try { + Object result = apiInstance.putAndCalculate(id, xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PaCalculationsApi#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 PA calculation endpoint | + **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation | [optional] + **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional] + **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.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/PaDoc.md b/auto-generated-sdk/docs/PaDoc.md new file mode 100644 index 00000000..3e85061b --- /dev/null +++ b/auto-generated-sdk/docs/PaDoc.md @@ -0,0 +1,17 @@ + + +# PaDoc + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | PA document path | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PricingSourcesApi.md b/auto-generated-sdk/docs/PricingSourcesApi.md new file mode 100644 index 00000000..6ec18e36 --- /dev/null +++ b/auto-generated-sdk/docs/PricingSourcesApi.md @@ -0,0 +1,97 @@ + +# PricingSourcesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPAPricingSources**](PricingSourcesApi.md#getPAPricingSources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources + + + +## getPAPricingSources + +> PAPricingSourceRoot getPAPricingSources(name, category, directory) + +Get PA pricing sources + +This endpoint lists all the PA pricing sources that can be applied to a PA 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.PricingSourcesApi; + +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"); + + PricingSourcesApi apiInstance = new PricingSourcesApi(defaultClient); + String name = ""; // String | PA pricing sources name + String category = ""; // String | PA pricing sources category + String directory = ""; // String | The directory to get the PA pricing sources in + try { + PAPricingSourceRoot result = apiInstance.getPAPricingSources(name, category, directory); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PricingSourcesApi#getPAPricingSources"); + 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 +------------- | ------------- | ------------- | ------------- + **name** | **String**| PA pricing sources name | [optional] [default to ] + **category** | **String**| PA pricing sources category | [optional] [default to ] + **directory** | **String**| The directory to get the PA pricing sources in | [optional] [default to ] + +### Return type + +[**PAPricingSourceRoot**](PAPricingSourceRoot.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 PA pricing sources | * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. | * 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** | Pricing sources 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/Section.md b/auto-generated-sdk/docs/Section.md new file mode 100644 index 00000000..d34f4679 --- /dev/null +++ b/auto-generated-sdk/docs/Section.md @@ -0,0 +1,20 @@ + + +# Section + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | [**Metadata**](Metadata.md) | | [optional] +**title** | **String** | Commentary title | [optional] +**content** | **String** | Generated commentary content | [optional] +**subSections** | [**java.util.List<Section>**](Section.md) | Generated commentary subsections | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/StrategyDocumentsApi.md b/auto-generated-sdk/docs/StrategyDocumentsApi.md index 8ee4ae18..69f8a046 100644 --- a/auto-generated-sdk/docs/StrategyDocumentsApi.md +++ b/auto-generated-sdk/docs/StrategyDocumentsApi.md @@ -8,6 +8,7 @@ Method | HTTP request | Description [**getAxiomaEquityStrategyDocuments**](StrategyDocumentsApi.md#getAxiomaEquityStrategyDocuments) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory [**getAxiomaFIStrategyDocuments**](StrategyDocumentsApi.md#getAxiomaFIStrategyDocuments) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory [**getBarraStrategyDocuments**](StrategyDocumentsApi.md#getBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory +[**getFPOStrategyDocuments**](StrategyDocumentsApi.md#getFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory [**getNorthfieldStrategyDocuments**](StrategyDocumentsApi.md#getNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory @@ -261,6 +262,89 @@ 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.
| +## getFPOStrategyDocuments + +> DocumentDirectoriesRoot getFPOStrategyDocuments(path) + +Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory + +This endpoint looks up all FactSet Portfolio Optimizer strategy 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.StrategyDocumentsApi; + +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"); + + StrategyDocumentsApi apiInstance = new StrategyDocumentsApi(defaultClient); + String path = "Client:"; // String | The directory to get the strategy documents and sub-directories in + try { + DocumentDirectoriesRoot result = apiInstance.getFPOStrategyDocuments(path); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StrategyDocumentsApi#getFPOStrategyDocuments"); + 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 strategy documents and sub-directories in | + +### 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 FactSet Portfolio Optimizer strategy 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.
| + + ## getNorthfieldStrategyDocuments > DocumentDirectoriesRoot getNorthfieldStrategyDocuments(path) diff --git a/auto-generated-sdk/docs/TemplateContentTypes.md b/auto-generated-sdk/docs/TemplateContentTypes.md new file mode 100644 index 00000000..bd7fffe3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplateContentTypes.md @@ -0,0 +1,19 @@ + + +# TemplateContentTypes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mandatory** | **java.util.List<String>** | Template mandatory fields | [optional] +**optional** | **java.util.List<String>** | Template optional fields | [optional] +**locked** | **java.util.List<String>** | Template locked fields | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponent.md b/auto-generated-sdk/docs/TemplatedPAComponent.md new file mode 100644 index 00000000..9807c2d7 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponent.md @@ -0,0 +1,24 @@ + + +# TemplatedPAComponent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**directory** | **String** | | [optional] +**snapshot** | **Boolean** | | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md new file mode 100644 index 00000000..d8ee233a --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md @@ -0,0 +1,20 @@ + + +# TemplatedPAComponentParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | Directory to create templated components | +**parentTemplateId** | **String** | Parent template id | +**description** | **String** | Component description. | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md new file mode 100644 index 00000000..3962efcc --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md new file mode 100644 index 00000000..b7b275c4 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md @@ -0,0 +1,21 @@ + + +# TemplatedPAComponentPostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md new file mode 100644 index 00000000..26470db3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentPostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md new file mode 100644 index 00000000..5c49c451 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md new file mode 100644 index 00000000..ca4d272c --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md @@ -0,0 +1,20 @@ + + +# TemplatedPAComponentSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md new file mode 100644 index 00000000..2c872ec6 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, TemplatedPAComponentSummary>**](TemplatedPAComponentSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md new file mode 100644 index 00000000..5aa26595 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md @@ -0,0 +1,19 @@ + + +# TemplatedPAComponentUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parentTemplateId** | **String** | Parent template id | [optional] +**description** | **String** | Component description. | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md new file mode 100644 index 00000000..120428e3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md new file mode 100644 index 00000000..73842a3e --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md @@ -0,0 +1,467 @@ + +# TemplatedPaComponentsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createTemplatedPAComponents**](TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +[**deleteTemplatedPAComponents**](TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +[**getTemplatedPAComponentById**](TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +[**getTemplatedPAComponentsInPath**](TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +[**updateTemplatedPAComponents**](TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component + + + +## createTemplatedPAComponents + +> TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(templatedPAComponentParametersRoot) + +Create templated PA component + +This endpoint creates new component based off of linked PA template or unlinked PA template. + +Remarks: + +* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* Multi-horizon frequencies are not supported through this endpoint. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding + the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### 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.TemplatedPaComponentsApi; + +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"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = new TemplatedPAComponentParametersRoot(); // TemplatedPAComponentParametersRoot | Request Parameters + try { + TemplatedPAComponentPostSummaryRoot result = apiInstance.createTemplatedPAComponents(templatedPAComponentParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#createTemplatedPAComponents"); + 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 +------------- | ------------- | ------------- | ------------- + **templatedPAComponentParametersRoot** | [**TemplatedPAComponentParametersRoot**](TemplatedPAComponentParametersRoot.md)| Request Parameters | + +### Return type + +[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.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 | +|-------------|-------------|------------------| +| **201** | Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. | * 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.
| +| **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.
| +| **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.
| + + +## deleteTemplatedPAComponents + +> deleteTemplatedPAComponents(id) + +Delete templated PA component + +This endpoint deletes an existing templated PA component + +### 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.TemplatedPaComponentsApi; + +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"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component + try { + apiInstance.deleteTemplatedPAComponents(id); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#deleteTemplatedPAComponents"); + 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**| Unique identifier for a templated PA component | + +### Return type + +null (empty response body) + +### 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 | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. | * 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** | Component 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.
| + + +## getTemplatedPAComponentById + +> TemplatedPAComponentRoot getTemplatedPAComponentById(id) + +Get templated PA component by id + +This endpoint fetches the templated PA component settings. + +### 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.TemplatedPaComponentsApi; + +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"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component + try { + TemplatedPAComponentRoot result = apiInstance.getTemplatedPAComponentById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentById"); + 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**| Unique identifier for a templated PA component | + +### Return type + +[**TemplatedPAComponentRoot**](TemplatedPAComponentRoot.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, templated PA component details. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Templated PA component 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.
| + + +## getTemplatedPAComponentsInPath + +> TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(directory) + +Get templated PA components in path + +This endpoint returns the list of templated PA components in path. + +### 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.TemplatedPaComponentsApi; + +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"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String directory = "Personal:TemplatedPAComponents/"; // String | Get templated PA components in path + try { + TemplatedPAComponentSummaryRoot result = apiInstance.getTemplatedPAComponentsInPath(directory); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentsInPath"); + 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 +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get templated PA components in path | + +### Return type + +[**TemplatedPAComponentSummaryRoot**](TemplatedPAComponentSummaryRoot.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 templated PA 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## updateTemplatedPAComponents + +> TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(id, templatedPAComponentUpdateParametersRoot) + +Update templated PA component + +This endpoint allows the user to change the request body from an existing templated PA component. + +Remarks: + +* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* Multi-horizon frequencies are not supported through this endpoint. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding + the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### 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.TemplatedPaComponentsApi; + +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"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + 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); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#updateTemplatedPAComponents"); + 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**| Unique identifier for a templated PA component | + **templatedPAComponentUpdateParametersRoot** | [**TemplatedPAComponentUpdateParametersRoot**](TemplatedPAComponentUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.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, updated 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 data provided. Please check the request parameters before attempting again. | * 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** | Component or 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.
| + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md new file mode 100644 index 00000000..6373dde5 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplate.md @@ -0,0 +1,32 @@ + + +# UnlinkedPATemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**directory** | **String** | Template directory. | [optional] +**templateTypeId** | **String** | Template type id | [optional] +**snapshot** | **Boolean** | snapshot. | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md new file mode 100644 index 00000000..57284683 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndType + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | **String** | Unlinked template category | [optional] +**name** | **String** | Unlinked template type | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md new file mode 100644 index 00000000..74d9792b --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md @@ -0,0 +1,22 @@ + + +# UnlinkedPATemplateCategoryAndTypeDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Type Id | [optional] +**columns** | [**java.util.List<UnlinkedPATemplateColumnDetails>**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] +**groups** | [**java.util.List<UnlinkedPATemplateGroupDetails>**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] +**snapshot** | **Boolean** | Snapshot | [optional] +**category** | **String** | Unlinked template category | [optional] +**name** | **String** | Unlinked template type | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md new file mode 100644 index 00000000..a402f96d --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndTypeDetailsRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md new file mode 100644 index 00000000..577c8681 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndTypeRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, UnlinkedPATemplateCategoryAndType>**](UnlinkedPATemplateCategoryAndType.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md new file mode 100644 index 00000000..6c4cc890 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md @@ -0,0 +1,19 @@ + + +# UnlinkedPATemplateColumnDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Unlinked template column name | [optional] +**id** | **String** | FactSet-defined or User-defined Column identifier. | [optional] +**statistics** | **java.util.List<String>** | Column Statistic identifier | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md new file mode 100644 index 00000000..34bbd3c0 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md @@ -0,0 +1,19 @@ + + +# UnlinkedPATemplateGroupDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Unlinked template group name | [optional] +**id** | **String** | FactSet-defined or User-defined Group identifier. | [optional] +**frequency** | **String** | Grouping frequency | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md new file mode 100644 index 00000000..6565a410 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md @@ -0,0 +1,28 @@ + + +# UnlinkedPATemplateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | The directory to create an unlinked PA template | +**templateTypeId** | **String** | Template type id | +**description** | **String** | Template description | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..7f89e17d --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md new file mode 100644 index 00000000..4ba7f514 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md @@ -0,0 +1,20 @@ + + +# UnlinkedPATemplatePostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..6f488e6e --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplatePostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md new file mode 100644 index 00000000..2821b693 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md new file mode 100644 index 00000000..879862c1 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md @@ -0,0 +1,19 @@ + + +# UnlinkedPATemplateSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..79061ec3 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, UnlinkedPATemplateSummary>**](UnlinkedPATemplateSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..f4cd57b9 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md @@ -0,0 +1,26 @@ + + +# UnlinkedPATemplateUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..61284b1f --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md new file mode 100644 index 00000000..7bb95b81 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md @@ -0,0 +1,648 @@ + +# UnlinkedPaTemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +[**deleteUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +[**getDefaultUnlinkedPATemplateTypes**](UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +[**getDetailsType**](UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +[**getUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates +[**getUnlinkedPATemplatesById**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id +[**updateUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#updateUnlinkedPATemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template + + + +## createUnlinkedPATemplates + +> UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(unlinkedPATemplateParametersRoot) + +Create unlinked PA template + +This endpoint creates a template which is not linked to any specific PA3 tile. + +Remarks: + +* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. + If no mandatory fields are passed, then we can use the template as a component and skip the component creation. + +* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* Multi-horizon frequencies are not supported through this endpoint. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also + overriding the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = new UnlinkedPATemplateParametersRoot(); // UnlinkedPATemplateParametersRoot | Request Parameters + try { + UnlinkedPATemplatePostSummaryRoot result = apiInstance.createUnlinkedPATemplates(unlinkedPATemplateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#createUnlinkedPATemplates"); + 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 +------------- | ------------- | ------------- | ------------- + **unlinkedPATemplateParametersRoot** | [**UnlinkedPATemplateParametersRoot**](UnlinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + +[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.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 | +|-------------|-------------|------------------| +| **201** | Expected response, created a unlinked PA 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.
| +| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| + + +## deleteUnlinkedPATemplates + +> deleteUnlinkedPATemplates(id) + +Delete unlinked PA template + +This endpoint deletes an existing unliked PA 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template + try { + apiInstance.deleteUnlinkedPATemplates(id); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#deleteUnlinkedPATemplates"); + 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**| Unique identifier for an unlinked PA template | + +### Return type + +null (empty response body) + +### 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 | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## getDefaultUnlinkedPATemplateTypes + +> UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() + +Get default unlinked PA template types. + +This endpoint fetches default unlinked PA template types. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + try { + UnlinkedPATemplateCategoryAndTypeRoot result = apiInstance.getDefaultUnlinkedPATemplateTypes(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDefaultUnlinkedPATemplateTypes"); + 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 + +[**UnlinkedPATemplateCategoryAndTypeRoot**](UnlinkedPATemplateCategoryAndTypeRoot.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, default unlinked PA template types | * 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.
| + + +## getDetailsType + +> UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(id) + +Get unlinked PA template type details by id. + +This endpoint fetches the unlinked PA template type details. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for an unlinked PA template type + try { + UnlinkedPATemplateCategoryAndTypeDetailsRoot result = apiInstance.getDetailsType(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDetailsType"); + 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**| Unique identifier for an unlinked PA template type | + +### Return type + +[**UnlinkedPATemplateCategoryAndTypeDetailsRoot**](UnlinkedPATemplateCategoryAndTypeDetailsRoot.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, details of the unlinked PA template type | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Unlinked PA template type 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.
| + + +## getUnlinkedPATemplates + +> UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(directory, category) + +Get unlinked PA templates + +This endpoint returns the list of unlinked PA templates. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + 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); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplates"); + 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 +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get unlinked PA templates in path. | [optional] + **category** | **String**| Get unlinked PA templates by category. | [optional] + +### Return type + +[**UnlinkedPATemplateSummaryRoot**](UnlinkedPATemplateSummaryRoot.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 unlinked PA templates. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## getUnlinkedPATemplatesById + +> UnlinkedPATemplateRoot getUnlinkedPATemplatesById(id) + +Get unlinked PA template details by id + +This endpoint fetches the template settings. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template + try { + UnlinkedPATemplateRoot result = apiInstance.getUnlinkedPATemplatesById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplatesById"); + 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**| Unique identifier for an unlinked PA template | + +### Return type + +[**UnlinkedPATemplateRoot**](UnlinkedPATemplateRoot.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, get details of the unlinked PA 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.
| +| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| + + +## updateUnlinkedPATemplates + +> UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(id, unlinkedPATemplateUpdateParametersRoot) + +Update unlinked PA template + +This endpoint updates an existing unlinked PA template. + +Remarks: + +* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. + If no mandatory fields are passed, then we can use the template as a component and skip the component creation. + +* Mandatory, optional and locked fields can be "accounts", "benchmarks", "groups", "columns", "datasources", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Any settings in the POST body will act as a one-time override over the settings saved in the PA template. + +* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. + Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), + VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. + +* Multi-horizon frequencies are not supported through this endpoint. + +* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. + Additionally, while 'groupsall' returns all the group levels in the PA component, + setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding + the default frequency of the Beginning of Period to whatever we pass in the request body. + +* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### 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.UnlinkedPaTemplatesApi; + +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"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + 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); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#updateUnlinkedPATemplates"); + 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**| Unique identifier for an unlinked PA template | + **unlinkedPATemplateUpdateParametersRoot** | [**UnlinkedPATemplateUpdateParametersRoot**](UnlinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.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, updated the unlinked PA 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.
| +| **400** | Invalid data provided. Please check the request parameters before attempting again. | * 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.
| + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java new file mode 100644 index 00000000..a61800f7 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -0,0 +1,123 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ColumnStatisticRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnStatisticsApi { + private ApiClient apiClient; + public ColumnStatisticsApi() { + this(Configuration.getDefaultApiClient()); + } + + public ColumnStatisticsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get PA column statistics + * This endpoint lists all the column statistics that can be applied to a PA column. + @return ColumnStatisticRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA column statistics * 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 ColumnStatisticRoot getPAColumnStatistics() throws ApiException { + return getPAColumnStatisticsWithHttpInfo().getData(); + } + + /** + * Get PA column statistics + * This endpoint lists all the column statistics that can be applied to a PA column. + * @return ApiResponse<ColumnStatisticRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA column statistics * 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 getPAColumnStatisticsWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/columnstatistics"; + + // 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("ColumnStatisticsApi.getPAColumnStatistics", 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/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java new file mode 100644 index 00000000..6889b457 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -0,0 +1,223 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.ColumnRoot; +import factset.analyticsapi.engines.models.ColumnSummaryRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnsApi { + private ApiClient apiClient; + public ColumnsApi() { + this(Configuration.getDefaultApiClient()); + } + + public ColumnsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get PA column settings + * This endpoint returns the default settings of a PA column. + * @param id Unique identifier for a column (required) + @return ColumnRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns settings of a PA column. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. * 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 Column 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 ColumnRoot getPAColumnById(String id) throws ApiException { + return getPAColumnByIdWithHttpInfo(id).getData(); + } + + /** + * Get PA column settings + * This endpoint returns the default settings of a PA column. + * @param id Unique identifier for a column (required) + * @return ApiResponse<ColumnRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns settings of a PA column. * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 column Id. * 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 Column 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 getPAColumnByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getPAColumnById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/columns/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("ColumnsApi.getPAColumnById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA columns + * This endpoint lists all the PA columns that can be applied to a calculation. + * @param name Column name (optional, default to ) + * @param category Column category (optional, default to ) + * @param directory The directory to get the columns in (optional, default to ) + @return ColumnSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA columns * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 ColumnSummaryRoot getPAColumns(String name, String category, String directory) throws ApiException { + return getPAColumnsWithHttpInfo(name, category, directory).getData(); + } + + /** + * Get PA columns + * This endpoint lists all the PA columns that can be applied to a calculation. + * @param name Column name (optional, default to ) + * @param category Column category (optional, default to ) + * @param directory The directory to get the columns in (optional, default to ) + * @return ApiResponse<ColumnSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA columns * 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.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* 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 getPAColumnsWithHttpInfo(String name, String category, String directory) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/columns"; + + // 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("", "name", name)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); + + + + + 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("ColumnsApi.getPAColumns", 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 47e75669..f7f22832 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 @@ -16,6 +16,7 @@ import factset.analyticsapi.engines.models.ClientErrorResponse; import factset.analyticsapi.engines.models.ComponentSummaryRoot; +import factset.analyticsapi.engines.models.PAComponentRoot; import factset.analyticsapi.engines.models.SPARComponentRoot; import factset.analyticsapi.engines.models.VaultComponentRoot; @@ -48,6 +49,184 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Get PA component by id + * This endpoint returns the default settings of a PA component. + * @param id Unique identifier for a PA component (required) + @return PAComponentRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the default settings of a PA component. * 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 PA component id. * 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 Component 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 PAComponentRoot getPAComponentById(String id) throws ApiException { + return getPAComponentByIdWithHttpInfo(id).getData(); + } + + /** + * Get PA component by id + * This endpoint returns the default settings of a PA component. + * @param id Unique identifier for a PA component (required) + * @return ApiResponse<PAComponentRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the default settings of a PA component. * 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 PA component id. * 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 Component 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 getPAComponentByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getPAComponentById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("ComponentsApi.getPAComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA components + * This endpoint returns the list of PA components in a given PA 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 PA 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 PA 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 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 getPAComponents(String document) throws ApiException { + return getPAComponentsWithHttpInfo(document).getData(); + } + + /** + * Get PA components + * This endpoint returns the list of PA components in a given PA 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 PA 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 PA 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 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 getPAComponentsWithHttpInfo(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 getPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/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.getPAComponents", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Get SPAR component by id * This endpoint returns the default settings of a SPAR component. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 031e51f2..9a1d0dd6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -15,6 +15,7 @@ import java.io.File; import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.PACommentaryConfigurationSummaryRoot; import factset.analyticsapi.engines.models.VaultConfigurationRoot; import factset.analyticsapi.engines.models.VaultConfigurationSummaryRoot; @@ -47,6 +48,92 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Get PA commentary configurations in a directory + * This endpoint returns all PA commentary configurations in a given directory. + * @param path The directory to get the PA commentary configurations (required) + @return PACommentaryConfigurationSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a map of configuration ID to PA commentary configuration * 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 path 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.
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 PACommentaryConfigurationSummaryRoot getPACommentaryConfigurations(String path) throws ApiException { + return getPACommentaryConfigurationsWithHttpInfo(path).getData(); + } + + /** + * Get PA commentary configurations in a directory + * This endpoint returns all PA commentary configurations in a given directory. + * @param path The directory to get the PA commentary configurations (required) + * @return ApiResponse<PACommentaryConfigurationSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a map of configuration ID to PA commentary configuration * 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 path 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.
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 getPACommentaryConfigurationsWithHttpInfo(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 getPACommentaryConfigurations"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/commentary/configurations"; + + // 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("", "path", path)); + + + + + 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(){}); + + return apiClient.invokeAPIWithReturnMap("ConfigurationsApi.getPACommentaryConfigurations", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Get Vault configuration by id * This endpoint returns details for a Vault configuration as well as a list of accounts it is used in. 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 b372c303..f6f84ce0 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 @@ -46,6 +46,114 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Convert PA dates to absolute format + * 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 ( Account Name ending with .ACCT or .ACTM ) (required) + * @param startdate Start Date (optional) + @return DateParametersSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the converted dates in yyyymmdd format. * 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 is 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 Document or 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 DateParametersSummaryRoot convertPADatesToAbsoluteFormat(String enddate, String componentid, String account, String startdate) throws ApiException { + return convertPADatesToAbsoluteFormatWithHttpInfo(enddate, componentid, account, startdate).getData(); + } + + /** + * Convert PA dates to absolute format + * 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 ( Account Name ending with .ACCT or .ACTM ) (required) + * @param startdate Start Date (optional) + * @return ApiResponse<DateParametersSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the converted dates in yyyymmdd format. * 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 is 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 Document or 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 convertPADatesToAbsoluteFormatWithHttpInfo(String enddate, String componentid, String account, String startdate) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'enddate' is set + if (enddate == null) { + throw new ApiException(400, "Missing the required parameter 'enddate' when calling convertPADatesToAbsoluteFormat"); + } + + // verify the required parameter 'componentid' is set + if (componentid == null) { + throw new ApiException(400, "Missing the required parameter 'componentid' when calling convertPADatesToAbsoluteFormat"); + } + + // verify the required parameter 'account' is set + if (account == null) { + throw new ApiException(400, "Missing the required parameter 'account' when calling convertPADatesToAbsoluteFormat"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/dates"; + + // 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("", "startdate", startdate)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "enddate", enddate)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "componentid", componentid)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "account", account)); + + + + + 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("DatesApi.convertPADatesToAbsoluteFormat", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Convert Vault dates to absolute format * 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. 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 6ec32ac2..f40f73bb 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 @@ -46,6 +46,95 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Get PA3 documents and sub-directories in a directory + * This endpoint looks up all PA3 documents and sub-directories in a given directory. + * @param path The directory to get the documents and sub-directories 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 PA3 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 getPA3Documents(String path) throws ApiException { + return getPA3DocumentsWithHttpInfo(path).getData(); + } + + /** + * Get PA3 documents and sub-directories in a directory + * This endpoint looks up all PA3 documents and sub-directories in a given directory. + * @param path The directory to get the documents and sub-directories 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 PA3 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 getPA3DocumentsWithHttpInfo(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 getPA3Documents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/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.getPA3Documents", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Gets Publisher documents and sub-directories in a directory * This endpoint looks up all Publisher documents and sub-directories in a given directory. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java new file mode 100644 index 00000000..5c48f02c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -0,0 +1,592 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.CalculationInfoRoot; +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.FPOOptimizationParametersRoot; +import factset.analyticsapi.engines.models.ObjectRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FpoOptimizerApi { + private ApiClient apiClient; + public FpoOptimizerApi() { + this(Configuration.getDefaultApiClient()); + } + + public FpoOptimizerApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Cancel FPO optimization by id + * This is the endpoint to cancel a previously submitted optimization. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, optimization 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 optimization 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.
+ */ + public void cancelOptimizationById(String id) throws ApiException { + cancelOptimizationByIdWithHttpInfo(id); + } + + /** + * Cancel FPO optimization by id + * This is the endpoint to cancel a previously submitted optimization. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, optimization 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 optimization 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.
+ */ + public ApiResponse cancelOptimizationByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling cancelOptimizationById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { + "text/plain", "application/json", "text/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.cancelOptimizationById", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get FPO optimization parameters by id + * This is the endpoint that returns the optimization parameters passed for an optimization. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + @return FPOOptimizationParametersRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the FPO optimization 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 Optimization 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.
+ */ + public FPOOptimizationParametersRoot getOptimizationParameters(String id) throws ApiException { + return getOptimizationParametersWithHttpInfo(id).getData(); + } + + /** + * Get FPO optimization parameters by id + * This is the endpoint that returns the optimization parameters passed for an optimization. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @return ApiResponse<FPOOptimizationParametersRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the FPO optimization 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 Optimization 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.
+ */ + public ApiResponse getOptimizationParametersWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationParameters"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("FpoOptimizerApi.getOptimizationParameters", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get FPO optimization result by id + * This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. + * @param id from url, provided from the location header in the Get FPO optimization status by id endpoint (required) + * @param accept Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) + @return ObjectRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response once optimization is completed, returns JSON. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
+ */ + public ObjectRoot getOptimizationResult(String id, String accept) throws ApiException { + return getOptimizationResultWithHttpInfo(id, accept).getData(); + } + + /** + * Get FPO optimization result by id + * This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. + * @param id from url, provided from the location header in the Get FPO optimization status by id endpoint (required) + * @param accept Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) + * @return ApiResponse<ObjectRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response once optimization is completed, returns JSON. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
+ */ + public ApiResponse getOptimizationResultWithHttpInfo(String id, String accept) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationResult"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}/result" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); + + + if (accept != null) + localVarHeaderParams.put("Accept", apiClient.parameterToString(accept)); + + + + 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("FpoOptimizerApi.getOptimizationResult", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get FPO optimization status by id + * This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + @return (For 201 status - ObjectRoot)(For 202 status - null) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response once optimization is completed, returns 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.
202 Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
+ */ + public Object getOptimizationStatusById(String id) throws ApiException { + return getOptimizationStatusByIdWithHttpInfo(id).getData(); + } + + /** + * Get FPO optimization status by id + * This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @return ApiResponse<Object>(For 201 status - ObjectRoot)(For 202 status - null) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response once optimization is completed, returns 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.
202 Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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 Optimization result was already returned, provided id was not a requested optimization, or the optimization 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.
+ */ + public ApiResponse getOptimizationStatusByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getOptimizationStatusById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}/status" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.getOptimizationStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Create and Run FPO optimization + * This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param fpOOptimizationParametersRoot Optimization Parameters (optional) + @return (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 optimization 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 optimization 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 optimization 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.
+ */ + public Object postAndOptimize(Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { + return postAndOptimizeWithHttpInfo(xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot).getData(); + } + + /** + * Create and Run FPO optimization + * This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param fpOOptimizationParametersRoot Optimization Parameters (optional) + * @return ApiResponse<Object>(For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 optimization 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 optimization 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 optimization 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.
+ */ + public ApiResponse postAndOptimizeWithHttpInfo(Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { + Object localVarPostBody = fpOOptimizationParametersRoot; + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations"; + + // 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(); + + + if (xFactSetApiLongRunningDeadline != null) + localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); +if (cacheControl != null) + localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.postAndOptimize", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Create or Update FPO optimization and run it. + * 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. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param fpOOptimizationParametersRoot Optimization Parameters (optional) + @return (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 Optimization 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 optimization 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 optimization 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 optimization 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.
+ */ + public Object putAndOptimize(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { + return putAndOptimizeWithHttpInfo(id, xFactSetApiLongRunningDeadline, cacheControl, fpOOptimizationParametersRoot).getData(); + } + + /** + * Create or Update FPO optimization and run it. + * 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. + * @param id from url, provided from the location header in the Create and Run FPO optimization endpoint (required) + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param fpOOptimizationParametersRoot Optimization Parameters (optional) + * @return ApiResponse<Object>(For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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 optimization
* 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, returns json if optimization is completed in a short span. * 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 Optimization 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 optimization 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 optimization 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 optimization 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.
+ */ + public ApiResponse putAndOptimizeWithHttpInfo(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, FPOOptimizationParametersRoot fpOOptimizationParametersRoot) throws ApiException { + Object localVarPostBody = fpOOptimizationParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling putAndOptimize"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/optimizations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); + + + if (xFactSetApiLongRunningDeadline != null) + localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); +if (cacheControl != null) + localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + returnTypeMap.put(409, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("FpoOptimizerApi.putAndOptimize", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} 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 d78d37c4..b19aa140 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 @@ -45,6 +45,81 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Get PA frequencies + * This endpoint lists all the frequencies that can be applied to a PA 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 PA 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 getPAFrequencies() throws ApiException { + return getPAFrequenciesWithHttpInfo().getData(); + } + + /** + * Get PA frequencies + * This endpoint lists all the frequencies that can be applied to a PA 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 PA 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 getPAFrequenciesWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/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.getPAFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody, + 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. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java new file mode 100644 index 00000000..6ac12439 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -0,0 +1,199 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.FrequencyRoot; +import factset.analyticsapi.engines.models.GroupRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class GroupsApi { + private ApiClient apiClient; + public GroupsApi() { + this(Configuration.getDefaultApiClient()); + } + + public GroupsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get PA grouping frequencies + * This endpoint lists all the PA grouping frequencies that can be applied to a PA 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 PA grouping 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 getPAGroupingFrequencies() throws ApiException { + return getPAGroupingFrequenciesWithHttpInfo().getData(); + } + + /** + * Get PA grouping frequencies + * This endpoint lists all the PA grouping frequencies that can be applied to a PA 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 PA grouping 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 getPAGroupingFrequenciesWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/grouping-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("GroupsApi.getPAGroupingFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA groups + * This endpoint lists all the PA groups that can be applied to a PA calculation. + @return GroupRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA groups * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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 GroupRoot getPAGroups() throws ApiException { + return getPAGroupsWithHttpInfo().getData(); + } + + /** + * Get PA groups + * This endpoint lists all the PA groups that can be applied to a PA calculation. + * @return ApiResponse<GroupRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA groups * 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.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* 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 getPAGroupsWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/groups"; + + // 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("GroupsApi.getPAGroups", 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/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java new file mode 100644 index 00000000..520e4d9f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -0,0 +1,500 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.LinkedPATemplateParametersRoot; +import factset.analyticsapi.engines.models.LinkedPATemplatePostSummaryRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateSummaryRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPaTemplatesApi { + private ApiClient apiClient; + public LinkedPaTemplatesApi() { + this(Configuration.getDefaultApiClient()); + } + + public LinkedPaTemplatesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Create a linked PA template + * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param linkedPATemplateParametersRoot Request Parameters (required) + @return LinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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.
404 Component 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.
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 LinkedPATemplatePostSummaryRoot createLinkedPATemplates(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { + return createLinkedPATemplatesWithHttpInfo(linkedPATemplateParametersRoot).getData(); + } + + /** + * Create a linked PA template + * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param linkedPATemplateParametersRoot Request Parameters (required) + * @return ApiResponse<LinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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.
404 Component 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.
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 createLinkedPATemplatesWithHttpInfo(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { + Object localVarPostBody = linkedPATemplateParametersRoot; + + // verify the required parameter 'linkedPATemplateParametersRoot' is set + if (linkedPATemplateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'linkedPATemplateParametersRoot' when calling createLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates"; + + // 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 = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.createLinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete a linked PA template. + * This endpoint deletes an existing linked PA template. + * @param id Unique identifier for a linked PA template (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public void deleteLinkedPATemplates(String id) throws ApiException { + deleteLinkedPATemplatesWithHttpInfo(id); + } + + /** + * Delete a linked PA template. + * This endpoint deletes an existing linked PA template. + * @param id Unique identifier for a linked PA template (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the linked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse deleteLinkedPATemplatesWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.deleteLinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get linked PA templates + * This endpoint returns the list of linked PA templates in given path. + * @param directory Get linked PA templates in path. (optional) + * @param documentDirectory Get linked PA templates for documents in document path (optional) + * @param documentName Get linked PA templates for documents by document name (optional) + @return LinkedPATemplateSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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 LinkedPATemplateSummaryRoot getLinkedPATemplates(String directory, String documentDirectory, String documentName) throws ApiException { + return getLinkedPATemplatesWithHttpInfo(directory, documentDirectory, documentName).getData(); + } + + /** + * Get linked PA templates + * This endpoint returns the list of linked PA templates in given path. + * @param directory Get linked PA templates in path. (optional) + * @param documentDirectory Get linked PA templates for documents in document path (optional) + * @param documentName Get linked PA templates for documents by document name (optional) + * @return ApiResponse<LinkedPATemplateSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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 getLinkedPATemplatesWithHttpInfo(String directory, String documentDirectory, String documentName) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates"; + + // 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("", "directory", directory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentDirectory", documentDirectory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentName", documentName)); + + + + + 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("LinkedPaTemplatesApi.getLinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get linked PA template by id + * This endpoint fetches the linked PA template settings. + * @param id Unique identifier for a linked PA template (required) + @return LinkedPATemplateRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public LinkedPATemplateRoot getLinkedPATemplatesById(String id) throws ApiException { + return getLinkedPATemplatesByIdWithHttpInfo(id).getData(); + } + + /** + * Get linked PA template by id + * This endpoint fetches the linked PA template settings. + * @param id Unique identifier for a linked PA template (required) + * @return ApiResponse<LinkedPATemplateRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse getLinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getLinkedPATemplatesById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("LinkedPaTemplatesApi.getLinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Update a linked PA template + * This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param id Unique identifier for a linked PA template (required) + * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) + @return LinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 or component 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 LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { + return updateLinkedPATemplatesWithHttpInfo(id, linkedPATemplateUpdateParametersRoot).getData(); + } + + /** + * Update a linked PA template + * This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param id Unique identifier for a linked PA template (required) + * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<LinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 or component 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 updateLinkedPATemplatesWithHttpInfo(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { + Object localVarPostBody = linkedPATemplateUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateLinkedPATemplates"); + } + + // verify the required parameter 'linkedPATemplateUpdateParametersRoot' is set + if (linkedPATemplateUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'linkedPATemplateUpdateParametersRoot' when calling updateLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { + "application/json" + }; + 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("LinkedPaTemplatesApi.updateLinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java new file mode 100644 index 00000000..e6eb7833 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -0,0 +1,974 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.CalculationStatusRoot; +import factset.analyticsapi.engines.models.CalculationsSummaryRoot; +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.ObjectRoot; +import factset.analyticsapi.engines.models.PACalculationParametersRoot; +import factset.analyticsapi.engines.models.PACommentaryGetStatusRoot; +import factset.analyticsapi.engines.models.PACommentaryParametersRoot; +import factset.analyticsapi.engines.models.PACommentaryRoot; +import factset.analyticsapi.engines.models.PACommentaryStatusRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PaCalculationsApi { + private ApiClient apiClient; + public PaCalculationsApi() { + this(Configuration.getDefaultApiClient()); + } + + public PaCalculationsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Cancel PA calculation by id + * This is the endpoint to cancel a previously submitted calculation. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @throws ApiException if fails to make API call + * @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.
+ */ + public void cancelCalculationById(String id) throws ApiException { + cancelCalculationByIdWithHttpInfo(id); + } + + /** + * Cancel PA calculation by id + * This is the endpoint to cancel a previously submitted calculation. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @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.
+ */ + public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling cancelCalculationById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.cancelCalculationById", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Generate PA portfolio commentary by calculation and unit id. + * This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + * @param paCommentaryParametersRoot Request Parameters (optional) + @return (For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response if the commentary generation is completed in a short span, returns 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.
202 Expected response, contains the poll URL in the Location header. * Location - URL to poll for the resulting commentary
* 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.
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. 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.
+ */ + public Object generatePAPortfolioCommentary(String id, String unitId, PACommentaryParametersRoot paCommentaryParametersRoot) throws ApiException { + return generatePAPortfolioCommentaryWithHttpInfo(id, unitId, paCommentaryParametersRoot).getData(); + } + + /** + * Generate PA portfolio commentary by calculation and unit id. + * This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + * @param paCommentaryParametersRoot Request Parameters (optional) + * @return ApiResponse<Object>(For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response if the commentary generation is completed in a short span, returns 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.
202 Expected response, contains the poll URL in the Location header. * Location - URL to poll for the resulting commentary
* 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.
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. 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.
+ */ + public ApiResponse generatePAPortfolioCommentaryWithHttpInfo(String id, String unitId, PACommentaryParametersRoot paCommentaryParametersRoot) throws ApiException { + Object localVarPostBody = paCommentaryParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling generatePAPortfolioCommentary"); + } + + // verify the required parameter 'unitId' is set + if (unitId == null) { + throw new ApiException(400, "Missing the required parameter 'unitId' when calling generatePAPortfolioCommentary"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) + .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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 = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(202, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.generatePAPortfolioCommentary", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get all calculations + * This endpoints returns all calculation requests. + * @param pageNumber (optional, default to 1) + @return CalculationsSummaryRoot + * @throws ApiException if fails to make API call + * @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.
+ */ + public CalculationsSummaryRoot getAllCalculations(Integer pageNumber) throws ApiException { + return getAllCalculationsWithHttpInfo(pageNumber).getData(); + } + + /** + * Get all calculations + * This endpoints returns all calculation requests. + * @param pageNumber (optional, default to 1) + * @return ApiResponse<CalculationsSummaryRoot> + * @throws ApiException if fails to make API call + * @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.
+ */ + public ApiResponse getAllCalculationsWithHttpInfo(Integer pageNumber) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations"; + + // 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("", "pageNumber", pageNumber)); + + + + + 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("PaCalculationsApi.getAllCalculations", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA calculation parameters by id + * This is the endpoint that returns the calculation parameters passed for a calculation. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + @return PACalculationParametersRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the PA 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.
+ */ + public PACalculationParametersRoot getCalculationParameters(String id) throws ApiException { + return getCalculationParametersWithHttpInfo(id).getData(); + } + + /** + * Get PA calculation parameters by id + * This is the endpoint that returns the calculation parameters passed for a calculation. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @return ApiResponse<PACalculationParametersRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the PA 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.
+ */ + public ApiResponse getCalculationParametersWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationParameters"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("PaCalculationsApi.getCalculationParameters", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA 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. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + @return CalculationStatusRoot + * @throws ApiException if fails to make API call + * @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, should contain X-FactSet-Api-PickUp-Progress header. * 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.
+ */ + public CalculationStatusRoot getCalculationStatusById(String id) throws ApiException { + return getCalculationStatusByIdWithHttpInfo(id).getData(); + } + + /** + * Get PA 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. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @return ApiResponse<CalculationStatusRoot> + * @throws ApiException if fails to make API call + * @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, should contain X-FactSet-Api-PickUp-Progress header. * 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.
+ */ + public ApiResponse getCalculationStatusByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationStatusById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/status" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(202, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getCalculationStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA 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. + * @param id from url, provided from the location header in the Get PA calculation status by id endpoint (required) + * @param unitId from url, provided from the location header in the Get PA calculation status by id endpoint (required) + @return ObjectRoot + * @throws ApiException if fails to make API call + * @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.
+ */ + public ObjectRoot getCalculationUnitResultById(String id, String unitId) throws ApiException { + return getCalculationUnitResultByIdWithHttpInfo(id, unitId).getData(); + } + + /** + * Get PA 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. + * @param id from url, provided from the location header in the Get PA calculation status by id endpoint (required) + * @param unitId from url, provided from the location header in the Get PA calculation status by id endpoint (required) + * @return ApiResponse<ObjectRoot> + * @throws ApiException if fails to make API call + * @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.
+ */ + public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, String unitId) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getCalculationUnitResultById"); + } + + // verify the required parameter 'unitId' is set + if (unitId == null) { + throw new ApiException(400, "Missing the required parameter 'unitId' when calling getCalculationUnitResultById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) + .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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", "application/x-protobuf" + }; + 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("PaCalculationsApi.getCalculationUnitResultById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA Portfolio commentary result by calculation and unit id. + * This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + @return PACommentaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
200 Expected response once the commentary generation is completed, returns JSON. * 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.
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.
+ */ + public PACommentaryRoot getPAPortfolioCommentaryResultById(String id, String unitId) throws ApiException { + return getPAPortfolioCommentaryResultByIdWithHttpInfo(id, unitId).getData(); + } + + /** + * Get PA Portfolio commentary result by calculation and unit id. + * This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + * @return ApiResponse<PACommentaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
200 Expected response once the commentary generation is completed, returns JSON. * 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.
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.
+ */ + public ApiResponse getPAPortfolioCommentaryResultByIdWithHttpInfo(String id, String unitId) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getPAPortfolioCommentaryResultById"); + } + + // verify the required parameter 'unitId' is set + if (unitId == null) { + throw new ApiException(400, "Missing the required parameter 'unitId' when calling getPAPortfolioCommentaryResultById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) + .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getPAPortfolioCommentaryResultById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get PA portfolio commentary status by calculation and unit id. + * This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + @return (For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response once commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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.
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.
+ */ + public Object getPAPortfolioCommentaryStatusById(String id, String unitId) throws ApiException { + return getPAPortfolioCommentaryStatusByIdWithHttpInfo(id, unitId).getData(); + } + + /** + * Get PA portfolio commentary status by calculation and unit id. + * This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. + * @param id Successful calculation id (required) + * @param unitId Unit id associated with the successful calculation id (required) + * @return ApiResponse<Object>(For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response once commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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.
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.
+ */ + public ApiResponse getPAPortfolioCommentaryStatusByIdWithHttpInfo(String id, String unitId) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getPAPortfolioCommentaryStatusById"); + } + + // verify the required parameter 'unitId' is set + if (unitId == null) { + throw new ApiException(400, "Missing the required parameter 'unitId' when calling getPAPortfolioCommentaryStatusById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) + .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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(202, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getPAPortfolioCommentaryStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Create and Run PA calculation + * This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param paCalculationParametersRoot Calculation Parameters (optional) + @return (For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) + * @throws ApiException if fails to make API call + * @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.
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.
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.
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.
+ */ + public Object postAndCalculate(Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { + return postAndCalculateWithHttpInfo(xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot).getData(); + } + + /** + * Create and Run PA calculation + * This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param paCalculationParametersRoot Calculation Parameters (optional) + * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) + * @throws ApiException if fails to make API call + * @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.
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.
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.
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.
+ */ + public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { + Object localVarPostBody = paCalculationParametersRoot; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations"; + + // 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(); + + + if (xFactSetApiLongRunningDeadline != null) + localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); +if (cacheControl != null) + localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); + + + + final String[] localVarAccepts = { + "application/json", "application/x-protobuf" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.postAndCalculate", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Create or Update PA calculation and run it. + * This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param paCalculationParametersRoot Calculation Parameters (optional) + @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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.
+ */ + public Object putAndCalculate(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { + return putAndCalculateWithHttpInfo(id, xFactSetApiLongRunningDeadline, cacheControl, paCalculationParametersRoot).getData(); + } + + /** + * Create or Update PA calculation and run it. + * This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + * @param id from url, provided from the location header in the Create and Run PA calculation endpoint (required) + * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) + * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) + * @param paCalculationParametersRoot Calculation Parameters (optional) + * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) + * @throws ApiException if fails to make API call + * @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.
+ */ + public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactSetApiLongRunningDeadline, String cacheControl, PACalculationParametersRoot paCalculationParametersRoot) throws ApiException { + Object localVarPostBody = paCalculationParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling putAndCalculate"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/calculations/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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(); + + + if (xFactSetApiLongRunningDeadline != null) + localVarHeaderParams.put("X-FactSet-Api-Long-Running-Deadline", apiClient.parameterToString(xFactSetApiLongRunningDeadline)); +if (cacheControl != null) + localVarHeaderParams.put("Cache-Control", apiClient.parameterToString(cacheControl)); + + + + final String[] localVarAccepts = { + "application/json", "application/x-protobuf" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + returnTypeMap.put(409, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.putAndCalculate", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java new file mode 100644 index 00000000..f7a16890 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -0,0 +1,139 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.PAPricingSourceRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PricingSourcesApi { + private ApiClient apiClient; + public PricingSourcesApi() { + this(Configuration.getDefaultApiClient()); + } + + public PricingSourcesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get PA pricing sources + * This endpoint lists all the PA pricing sources that can be applied to a PA calculation. + * @param name PA pricing sources name (optional, default to ) + * @param category PA pricing sources category (optional, default to ) + * @param directory The directory to get the PA pricing sources in (optional, default to ) + @return PAPricingSourceRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA pricing sources * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. * 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 Pricing sources 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 PAPricingSourceRoot getPAPricingSources(String name, String category, String directory) throws ApiException { + return getPAPricingSourcesWithHttpInfo(name, category, directory).getData(); + } + + /** + * Get PA pricing sources + * This endpoint lists all the PA pricing sources that can be applied to a PA calculation. + * @param name PA pricing sources name (optional, default to ) + * @param category PA pricing sources category (optional, default to ) + * @param directory The directory to get the PA pricing sources in (optional, default to ) + * @return ApiResponse<PAPricingSourceRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of PA pricing sources * 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.
* Age - Standard HTTP header. Header will specify the age of pricing sources list cached response.
* 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 data provided. Please check the request parameters before attempting again. * 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 Pricing sources 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 getPAPricingSourcesWithHttpInfo(String name, String category, String directory) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/pricing-sources"; + + // 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("", "name", name)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); + + + + + 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("PricingSourcesApi.getPAPricingSources", 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/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index efe262ef..b31f7a3c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -313,6 +313,95 @@ public ApiResponse getBarraStrategyDocumentsWithHttpInf localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } + /** + * Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory + * This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. + * @param path The directory to get the strategy documents and sub-directories 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 FactSet Portfolio Optimizer strategy 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 getFPOStrategyDocuments(String path) throws ApiException { + return getFPOStrategyDocumentsWithHttpInfo(path).getData(); + } + + /** + * Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory + * This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. + * @param path The directory to get the strategy documents and sub-directories 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 FactSet Portfolio Optimizer strategy 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 getFPOStrategyDocumentsWithHttpInfo(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 getFPOStrategyDocuments"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/fpo/v3/strategies/{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("StrategyDocumentsApi.getFPOStrategyDocuments", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Get Northfield strategy documents and sub-directories in a directory * This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java new file mode 100644 index 00000000..8337e54b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -0,0 +1,496 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.TemplatedPAComponentParametersRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummaryRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentSummaryRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPaComponentsApi { + private ApiClient apiClient; + public TemplatedPaComponentsApi() { + this(Configuration.getDefaultApiClient()); + } + + public TemplatedPaComponentsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Create templated PA component + * This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param templatedPAComponentParametersRoot Request Parameters (required) + @return TemplatedPAComponentPostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. * 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.
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.
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 TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { + return createTemplatedPAComponentsWithHttpInfo(templatedPAComponentParametersRoot).getData(); + } + + /** + * Create templated PA component + * This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param templatedPAComponentParametersRoot Request Parameters (required) + * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, templated PA component created 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 data provided. Please check the request parameters before attempting again. * 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.
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.
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 createTemplatedPAComponentsWithHttpInfo(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { + Object localVarPostBody = templatedPAComponentParametersRoot; + + // verify the required parameter 'templatedPAComponentParametersRoot' is set + if (templatedPAComponentParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'templatedPAComponentParametersRoot' when calling createTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-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(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.createTemplatedPAComponents", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete templated PA component + * This endpoint deletes an existing templated PA component + * @param id Unique identifier for a templated PA component (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. * 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 Component 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 void deleteTemplatedPAComponents(String id) throws ApiException { + deleteTemplatedPAComponentsWithHttpInfo(id); + } + + /** + * Delete templated PA component + * This endpoint deletes an existing templated PA component + * @param id Unique identifier for a templated PA component (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the templated PA component 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 data provided. Please check the request parameters before attempting again. * 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 Component 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 deleteTemplatedPAComponentsWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.deleteTemplatedPAComponents", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get templated PA component by id + * This endpoint fetches the templated PA component settings. + * @param id Unique identifier for a templated PA component (required) + @return TemplatedPAComponentRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA component 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 TemplatedPAComponentRoot getTemplatedPAComponentById(String id) throws ApiException { + return getTemplatedPAComponentByIdWithHttpInfo(id).getData(); + } + + /** + * Get templated PA component by id + * This endpoint fetches the templated PA component settings. + * @param id Unique identifier for a templated PA component (required) + * @return ApiResponse<TemplatedPAComponentRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA component 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 getTemplatedPAComponentByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getTemplatedPAComponentById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("TemplatedPaComponentsApi.getTemplatedPAComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get templated PA components in path + * This endpoint returns the list of templated PA components in path. + * @param directory Get templated PA components in path (required) + @return TemplatedPAComponentSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list templated PA 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 data provided. Please check the request parameters before attempting again. * 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 TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(String directory) throws ApiException { + return getTemplatedPAComponentsInPathWithHttpInfo(directory).getData(); + } + + /** + * Get templated PA components in path + * This endpoint returns the list of templated PA components in path. + * @param directory Get templated PA components in path (required) + * @return ApiResponse<TemplatedPAComponentSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list templated PA 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 data provided. Please check the request parameters before attempting again. * 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 getTemplatedPAComponentsInPathWithHttpInfo(String directory) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'directory' is set + if (directory == null) { + throw new ApiException(400, "Missing the required parameter 'directory' when calling getTemplatedPAComponentsInPath"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-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("", "directory", directory)); + + + + + 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(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.getTemplatedPAComponentsInPath", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Update templated PA component + * This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param id Unique identifier for a templated PA component (required) + * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) + @return TemplatedPAComponentPostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated 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 data provided. Please check the request parameters before attempting again. * 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 Component or 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.
+ */ + public TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { + return updateTemplatedPAComponentsWithHttpInfo(id, templatedPAComponentUpdateParametersRoot).getData(); + } + + /** + * Update templated PA component + * This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param id Unique identifier for a templated PA component (required) + * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated 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 data provided. Please check the request parameters before attempting again. * 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 Component or 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.
+ */ + public ApiResponse updateTemplatedPAComponentsWithHttpInfo(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { + Object localVarPostBody = templatedPAComponentUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateTemplatedPAComponents"); + } + + // verify the required parameter 'templatedPAComponentUpdateParametersRoot' is set + if (templatedPAComponentUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'templatedPAComponentUpdateParametersRoot' when calling updateTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { + "application/json" + }; + 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("TemplatedPaComponentsApi.updateTemplatedPAComponents", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java new file mode 100644 index 00000000..7093fb25 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -0,0 +1,658 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetailsRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateParametersRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummaryRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateSummaryRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPaTemplatesApi { + private ApiClient apiClient; + public UnlinkedPaTemplatesApi() { + this(Configuration.getDefaultApiClient()); + } + + public UnlinkedPaTemplatesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Create unlinked PA template + * This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param unlinkedPATemplateParametersRoot Request Parameters (required) + @return UnlinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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 UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { + return createUnlinkedPATemplatesWithHttpInfo(unlinkedPATemplateParametersRoot).getData(); + } + + /** + * Create unlinked PA template + * This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param unlinkedPATemplateParametersRoot Request Parameters (required) + * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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 createUnlinkedPATemplatesWithHttpInfo(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { + Object localVarPostBody = unlinkedPATemplateParametersRoot; + + // verify the required parameter 'unlinkedPATemplateParametersRoot' is set + if (unlinkedPATemplateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateParametersRoot' when calling createUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; + + // 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 = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.createUnlinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete unlinked PA template + * This endpoint deletes an existing unliked PA template. + * @param id Unique identifier for an unlinked PA template (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public void deleteUnlinkedPATemplates(String id) throws ApiException { + deleteUnlinkedPATemplatesWithHttpInfo(id); + } + + /** + * Delete unlinked PA template + * This endpoint deletes an existing unliked PA template. + * @param id Unique identifier for an unlinked PA template (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse deleteUnlinkedPATemplatesWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.deleteUnlinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get default unlinked PA template types. + * This endpoint fetches default unlinked PA template types. + @return UnlinkedPATemplateCategoryAndTypeRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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 UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() throws ApiException { + return getDefaultUnlinkedPATemplateTypesWithHttpInfo().getData(); + } + + /** + * Get default unlinked PA template types. + * This endpoint fetches default unlinked PA template types. + * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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 getDefaultUnlinkedPATemplateTypesWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types"; + + // 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("UnlinkedPaTemplatesApi.getDefaultUnlinkedPATemplateTypes", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA template type details by id. + * This endpoint fetches the unlinked PA template type details. + * @param id Unique identifier for an unlinked PA template type (required) + @return UnlinkedPATemplateCategoryAndTypeDetailsRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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 UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(String id) throws ApiException { + return getDetailsTypeWithHttpInfo(id).getData(); + } + + /** + * Get unlinked PA template type details by id. + * This endpoint fetches the unlinked PA template type details. + * @param id Unique identifier for an unlinked PA template type (required) + * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeDetailsRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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 getDetailsTypeWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getDetailsType"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("UnlinkedPaTemplatesApi.getDetailsType", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA templates + * This endpoint returns the list of unlinked PA templates. + * @param directory Get unlinked PA templates in path. (optional) + * @param category Get unlinked PA templates by category. (optional) + @return UnlinkedPATemplateSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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 UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(String directory, String category) throws ApiException { + return getUnlinkedPATemplatesWithHttpInfo(directory, category).getData(); + } + + /** + * Get unlinked PA templates + * This endpoint returns the list of unlinked PA templates. + * @param directory Get unlinked PA templates in path. (optional) + * @param category Get unlinked PA templates by category. (optional) + * @return ApiResponse<UnlinkedPATemplateSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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 getUnlinkedPATemplatesWithHttpInfo(String directory, String category) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; + + // 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("", "directory", directory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); + + + + + 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(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getUnlinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA template details by id + * This endpoint fetches the template settings. + * @param id Unique identifier for an unlinked PA template (required) + @return UnlinkedPATemplateRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
+ */ + public UnlinkedPATemplateRoot getUnlinkedPATemplatesById(String id) throws ApiException { + return getUnlinkedPATemplatesByIdWithHttpInfo(id).getData(); + } + + /** + * Get unlinked PA template details by id + * This endpoint fetches the template settings. + * @param id Unique identifier for an unlinked PA template (required) + * @return ApiResponse<UnlinkedPATemplateRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse getUnlinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getUnlinkedPATemplatesById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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("UnlinkedPaTemplatesApi.getUnlinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Update unlinked PA template + * This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param id Unique identifier for an unlinked PA template (required) + * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) + @return UnlinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
+ */ + public UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { + return updateUnlinkedPATemplatesWithHttpInfo(id, unlinkedPATemplateUpdateParametersRoot).getData(); + } + + /** + * Update unlinked PA template + * This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * @param id Unique identifier for an unlinked PA template (required) + * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated the unlinked PA 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.
400 Invalid data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse updateUnlinkedPATemplatesWithHttpInfo(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { + Object localVarPostBody = unlinkedPATemplateUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateUnlinkedPATemplates"); + } + + // verify the required parameter 'unlinkedPATemplateUpdateParametersRoot' is set + if (unlinkedPATemplateUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateUpdateParametersRoot' when calling updateUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.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 = { + "application/json" + }; + 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("UnlinkedPaTemplatesApi.updateUnlinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java new file mode 100644 index 00000000..88b4cab4 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java @@ -0,0 +1,209 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * Column + */ +@JsonPropertyOrder({ + Column.JSON_PROPERTY_DEFAULTSTATISTICSIDS, + Column.JSON_PROPERTY_NAME, + Column.JSON_PROPERTY_DIRECTORY, + Column.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class Column implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DEFAULTSTATISTICSIDS = "defaultstatisticsids"; + private java.util.List defaultstatisticsids = null; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public Column defaultstatisticsids(java.util.List defaultstatisticsids) { + this.defaultstatisticsids = defaultstatisticsids; + return this; + } + + public Column addDefaultstatisticsidsItem(String defaultstatisticsidsItem) { + if (this.defaultstatisticsids == null) { + this.defaultstatisticsids = new java.util.ArrayList(); + } + this.defaultstatisticsids.add(defaultstatisticsidsItem); + return this; + } + + /** + * Column statistic Id + * @return defaultstatisticsids + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column statistic Id") + @JsonProperty(JSON_PROPERTY_DEFAULTSTATISTICSIDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getDefaultstatisticsids() { + return defaultstatisticsids; + } + + + public void setDefaultstatisticsids(java.util.List defaultstatisticsids) { + this.defaultstatisticsids = defaultstatisticsids; + } + + + public Column name(String name) { + this.name = name; + return this; + } + + /** + * Column Name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public Column directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Column Directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Directory") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public Column category(String category) { + this.category = category; + return this; + } + + /** + * Column Category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this Column object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Column column = (Column) o; + return Objects.equals(this.defaultstatisticsids, column.defaultstatisticsids) && + Objects.equals(this.name, column.name) && + Objects.equals(this.directory, column.directory) && + Objects.equals(this.category, column.category); + } + + @Override + public int hashCode() { + return Objects.hash(defaultstatisticsids, name, directory, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Column {\n"); + sb.append(" defaultstatisticsids: ").append(toIndentedString(defaultstatisticsids)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java new file mode 100644 index 00000000..082bb979 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.Column; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * ColumnRoot + */ +@JsonPropertyOrder({ + ColumnRoot.JSON_PROPERTY_DATA, + ColumnRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private Column data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public ColumnRoot data(Column data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public Column getData() { + return data; + } + + + public void setData(Column data) { + this.data = data; + } + + + public ColumnRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this ColumnRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ColumnRoot columnRoot = (ColumnRoot) o; + return Objects.equals(this.data, columnRoot.data) && + Objects.equals(this.meta, columnRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ColumnRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java new file mode 100644 index 00000000..400a58b9 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java @@ -0,0 +1,111 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * ColumnStatistic + */ +@JsonPropertyOrder({ + ColumnStatistic.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnStatistic implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + + public ColumnStatistic name(String name) { + this.name = name; + return this; + } + + /** + * Column Statistic Name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Statistic Name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this ColumnStatistic object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ColumnStatistic columnStatistic = (ColumnStatistic) o; + return Objects.equals(this.name, columnStatistic.name); + } + + @Override + public int hashCode() { + return Objects.hash(name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ColumnStatistic {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java new file mode 100644 index 00000000..17e2db55 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.ColumnStatistic; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * ColumnStatisticRoot + */ +@JsonPropertyOrder({ + ColumnStatisticRoot.JSON_PROPERTY_DATA, + ColumnStatisticRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnStatisticRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public ColumnStatisticRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public ColumnStatisticRoot putDataItem(String key, ColumnStatistic dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public ColumnStatisticRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this ColumnStatisticRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ColumnStatisticRoot columnStatisticRoot = (ColumnStatisticRoot) o; + return Objects.equals(this.data, columnStatisticRoot.data) && + Objects.equals(this.meta, columnStatisticRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ColumnStatisticRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java new file mode 100644 index 00000000..3e4751cf --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java @@ -0,0 +1,172 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * Column settings (name, directory, category) + */ +@ApiModel(description = "Column settings (name, directory, category)") +@JsonPropertyOrder({ + ColumnSummary.JSON_PROPERTY_NAME, + ColumnSummary.JSON_PROPERTY_DIRECTORY, + ColumnSummary.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public ColumnSummary name(String name) { + this.name = name; + return this; + } + + /** + * Column Name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public ColumnSummary directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Column Directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Directory") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public ColumnSummary category(String category) { + this.category = category; + return this; + } + + /** + * Column Category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this ColumnSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ColumnSummary columnSummary = (ColumnSummary) o; + return Objects.equals(this.name, columnSummary.name) && + Objects.equals(this.directory, columnSummary.directory) && + Objects.equals(this.category, columnSummary.category); + } + + @Override + public int hashCode() { + return Objects.hash(name, directory, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ColumnSummary {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java new file mode 100644 index 00000000..b176741b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.ColumnSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * ColumnSummaryRoot + */ +@JsonPropertyOrder({ + ColumnSummaryRoot.JSON_PROPERTY_DATA, + ColumnSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ColumnSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public ColumnSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public ColumnSummaryRoot putDataItem(String key, ColumnSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public ColumnSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this ColumnSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ColumnSummaryRoot columnSummaryRoot = (ColumnSummaryRoot) o; + return Objects.equals(this.data, columnSummaryRoot.data) && + Objects.equals(this.meta, columnSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ColumnSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java new file mode 100644 index 00000000..fb6bdcc3 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java @@ -0,0 +1,172 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.OptimizerAccountOverrides; +import factset.analyticsapi.engines.models.PaDoc; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOAccount + */ +@JsonPropertyOrder({ + FPOAccount.JSON_PROPERTY_PA_DOCUMENT, + FPOAccount.JSON_PROPERTY_ID, + FPOAccount.JSON_PROPERTY_OVERRIDES +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOAccount implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PA_DOCUMENT = "paDocument"; + private PaDoc paDocument; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_OVERRIDES = "overrides"; + private OptimizerAccountOverrides overrides; + + + public FPOAccount paDocument(PaDoc paDocument) { + this.paDocument = paDocument; + return this; + } + + /** + * Get paDocument + * @return paDocument + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_PA_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PaDoc getPaDocument() { + return paDocument; + } + + + public void setPaDocument(PaDoc paDocument) { + this.paDocument = paDocument; + } + + + public FPOAccount id(String id) { + this.id = id; + return this; + } + + /** + * Account path + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Account path") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public FPOAccount overrides(OptimizerAccountOverrides overrides) { + this.overrides = overrides; + return this; + } + + /** + * Get overrides + * @return overrides + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public OptimizerAccountOverrides getOverrides() { + return overrides; + } + + + public void setOverrides(OptimizerAccountOverrides overrides) { + this.overrides = overrides; + } + + + /** + * Return true if this FPOAccount object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOAccount fpOAccount = (FPOAccount) o; + return Objects.equals(this.paDocument, fpOAccount.paDocument) && + Objects.equals(this.id, fpOAccount.id) && + Objects.equals(this.overrides, fpOAccount.overrides); + } + + @Override + public int hashCode() { + return Objects.hash(paDocument, id, overrides); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOAccount {\n"); + sb.append(" paDocument: ").append(toIndentedString(paDocument)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" overrides: ").append(toIndentedString(overrides)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java new file mode 100644 index 00000000..b8824fb2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java @@ -0,0 +1,184 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOObjective + */ +@JsonPropertyOrder({ + FPOObjective.JSON_PROPERTY_ACTIVE, + FPOObjective.JSON_PROPERTY_TERMS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOObjective implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ACTIVE = "active"; + private String active; + + /** + * Gets or Sets inner + */ + public enum InnerEnum { + DISABLE("Disable"), + + ENABLE("Enable"); + + private String value; + + InnerEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static InnerEnum fromValue(String value) { + for (InnerEnum b : InnerEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TERMS = "terms"; + private java.util.Map terms = null; + + + public FPOObjective active(String active) { + this.active = active; + return this; + } + + /** + * Get active + * @return active + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ACTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getActive() { + return active; + } + + + public void setActive(String active) { + this.active = active; + } + + + public FPOObjective terms(java.util.Map terms) { + this.terms = terms; + return this; + } + + public FPOObjective putTermsItem(String key, InnerEnum termsItem) { + if (this.terms == null) { + this.terms = new java.util.HashMap(); + } + this.terms.put(key, termsItem); + return this; + } + + /** + * Get terms + * @return terms + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TERMS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.Map getTerms() { + return terms; + } + + + public void setTerms(java.util.Map terms) { + this.terms = terms; + } + + + /** + * Return true if this FPOObjective object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOObjective fpOObjective = (FPOObjective) o; + return Objects.equals(this.active, fpOObjective.active) && + Objects.equals(this.terms, fpOObjective.terms); + } + + @Override + public int hashCode() { + return Objects.hash(active, terms); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOObjective {\n"); + sb.append(" active: ").append(toIndentedString(active)).append("\n"); + sb.append(" terms: ").append(toIndentedString(terms)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java new file mode 100644 index 00000000..c126f314 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java @@ -0,0 +1,203 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FPOAccount; +import factset.analyticsapi.engines.models.FPOOptimizerStrategy; +import factset.analyticsapi.engines.models.Optimization; +import factset.analyticsapi.engines.models.OptimizerOutputTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOOptimizationParameters + */ +@JsonPropertyOrder({ + FPOOptimizationParameters.JSON_PROPERTY_ACCOUNT, + FPOOptimizationParameters.JSON_PROPERTY_STRATEGY, + FPOOptimizationParameters.JSON_PROPERTY_OPTIMIZATION, + FPOOptimizationParameters.JSON_PROPERTY_OUTPUT_TYPES +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOOptimizationParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ACCOUNT = "account"; + private FPOAccount account; + + public static final String JSON_PROPERTY_STRATEGY = "strategy"; + private FPOOptimizerStrategy strategy; + + public static final String JSON_PROPERTY_OPTIMIZATION = "optimization"; + private Optimization optimization; + + public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; + private OptimizerOutputTypes outputTypes; + + + public FPOOptimizationParameters account(FPOAccount account) { + this.account = account; + return this; + } + + /** + * Get account + * @return account + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FPOAccount getAccount() { + return account; + } + + + public void setAccount(FPOAccount account) { + this.account = account; + } + + + public FPOOptimizationParameters strategy(FPOOptimizerStrategy strategy) { + this.strategy = strategy; + return this; + } + + /** + * Get strategy + * @return strategy + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public FPOOptimizerStrategy getStrategy() { + return strategy; + } + + + public void setStrategy(FPOOptimizerStrategy strategy) { + this.strategy = strategy; + } + + + public FPOOptimizationParameters optimization(Optimization optimization) { + this.optimization = optimization; + return this; + } + + /** + * Get optimization + * @return optimization + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Optimization getOptimization() { + return optimization; + } + + + public void setOptimization(Optimization optimization) { + this.optimization = optimization; + } + + + public FPOOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { + this.outputTypes = outputTypes; + return this; + } + + /** + * Get outputTypes + * @return outputTypes + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public OptimizerOutputTypes getOutputTypes() { + return outputTypes; + } + + + public void setOutputTypes(OptimizerOutputTypes outputTypes) { + this.outputTypes = outputTypes; + } + + + /** + * Return true if this FPOOptimizationParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOOptimizationParameters fpOOptimizationParameters = (FPOOptimizationParameters) o; + return Objects.equals(this.account, fpOOptimizationParameters.account) && + Objects.equals(this.strategy, fpOOptimizationParameters.strategy) && + Objects.equals(this.optimization, fpOOptimizationParameters.optimization) && + Objects.equals(this.outputTypes, fpOOptimizationParameters.outputTypes); + } + + @Override + public int hashCode() { + return Objects.hash(account, strategy, optimization, outputTypes); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOOptimizationParameters {\n"); + sb.append(" account: ").append(toIndentedString(account)).append("\n"); + sb.append(" strategy: ").append(toIndentedString(strategy)).append("\n"); + sb.append(" optimization: ").append(toIndentedString(optimization)).append("\n"); + sb.append(" outputTypes: ").append(toIndentedString(outputTypes)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java new file mode 100644 index 00000000..431858b5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java @@ -0,0 +1,142 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FPOOptimizationParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOOptimizationParametersRoot + */ +@JsonPropertyOrder({ + FPOOptimizationParametersRoot.JSON_PROPERTY_DATA, + FPOOptimizationParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOOptimizationParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private FPOOptimizationParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public FPOOptimizationParametersRoot data(FPOOptimizationParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FPOOptimizationParameters getData() { + return data; + } + + + public void setData(FPOOptimizationParameters data) { + this.data = data; + } + + + public FPOOptimizationParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this FPOOptimizationParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOOptimizationParametersRoot fpOOptimizationParametersRoot = (FPOOptimizationParametersRoot) o; + return Objects.equals(this.data, fpOOptimizationParametersRoot.data) && + Objects.equals(this.meta, fpOOptimizationParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOOptimizationParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java new file mode 100644 index 00000000..914447ab --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FPOOptimizerStrategyOverrides; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOOptimizerStrategy + */ +@JsonPropertyOrder({ + FPOOptimizerStrategy.JSON_PROPERTY_OVERRIDES, + FPOOptimizerStrategy.JSON_PROPERTY_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOOptimizerStrategy implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_OVERRIDES = "overrides"; + private FPOOptimizerStrategyOverrides overrides; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + + public FPOOptimizerStrategy overrides(FPOOptimizerStrategyOverrides overrides) { + this.overrides = overrides; + return this; + } + + /** + * Get overrides + * @return overrides + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FPOOptimizerStrategyOverrides getOverrides() { + return overrides; + } + + + public void setOverrides(FPOOptimizerStrategyOverrides overrides) { + this.overrides = overrides; + } + + + public FPOOptimizerStrategy id(String id) { + this.id = id; + return this; + } + + /** + * OptimizerStrategy document path + * @return id + **/ + @ApiModelProperty(required = true, value = "OptimizerStrategy document path") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + /** + * Return true if this FPOOptimizerStrategy object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOOptimizerStrategy fpOOptimizerStrategy = (FPOOptimizerStrategy) o; + return Objects.equals(this.overrides, fpOOptimizerStrategy.overrides) && + Objects.equals(this.id, fpOOptimizerStrategy.id); + } + + @Override + public int hashCode() { + return Objects.hash(overrides, id); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOOptimizerStrategy {\n"); + sb.append(" overrides: ").append(toIndentedString(overrides)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java new file mode 100644 index 00000000..8ab92107 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java @@ -0,0 +1,245 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FPOObjective; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOOptimizerStrategyOverrides + */ +@JsonPropertyOrder({ + FPOOptimizerStrategyOverrides.JSON_PROPERTY_OBJECTIVE, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_CONSTRAINTS, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_ALPHA, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_TRANSACTION_COST +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOOptimizerStrategyOverrides implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_OBJECTIVE = "objective"; + private FPOObjective objective; + + /** + * Gets or Sets inner + */ + public enum InnerEnum { + DISABLE("Disable"), + + ENABLE("Enable"); + + private String value; + + InnerEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static InnerEnum fromValue(String value) { + for (InnerEnum b : InnerEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_CONSTRAINTS = "constraints"; + private java.util.Map constraints = null; + + public static final String JSON_PROPERTY_ALPHA = "alpha"; + private String alpha; + + public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; + private String transactionCost; + + + public FPOOptimizerStrategyOverrides objective(FPOObjective objective) { + this.objective = objective; + return this; + } + + /** + * Get objective + * @return objective + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OBJECTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FPOObjective getObjective() { + return objective; + } + + + public void setObjective(FPOObjective objective) { + this.objective = objective; + } + + + public FPOOptimizerStrategyOverrides constraints(java.util.Map constraints) { + this.constraints = constraints; + return this; + } + + public FPOOptimizerStrategyOverrides putConstraintsItem(String key, InnerEnum constraintsItem) { + if (this.constraints == null) { + this.constraints = new java.util.HashMap(); + } + this.constraints.put(key, constraintsItem); + return this; + } + + /** + * List of constraints + * @return constraints + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of constraints") + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.Map getConstraints() { + return constraints; + } + + + public void setConstraints(java.util.Map constraints) { + this.constraints = constraints; + } + + + public FPOOptimizerStrategyOverrides alpha(String alpha) { + this.alpha = alpha; + return this; + } + + /** + * Alpha + * @return alpha + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Alpha") + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getAlpha() { + return alpha; + } + + + public void setAlpha(String alpha) { + this.alpha = alpha; + } + + + public FPOOptimizerStrategyOverrides transactionCost(String transactionCost) { + this.transactionCost = transactionCost; + return this; + } + + /** + * Transaction cost + * @return transactionCost + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Transaction cost") + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTransactionCost() { + return transactionCost; + } + + + public void setTransactionCost(String transactionCost) { + this.transactionCost = transactionCost; + } + + + /** + * Return true if this FPOOptimizerStrategyOverrides object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOOptimizerStrategyOverrides fpOOptimizerStrategyOverrides = (FPOOptimizerStrategyOverrides) o; + return Objects.equals(this.objective, fpOOptimizerStrategyOverrides.objective) && + Objects.equals(this.constraints, fpOOptimizerStrategyOverrides.constraints) && + Objects.equals(this.alpha, fpOOptimizerStrategyOverrides.alpha) && + Objects.equals(this.transactionCost, fpOOptimizerStrategyOverrides.transactionCost); + } + + @Override + public int hashCode() { + return Objects.hash(objective, constraints, alpha, transactionCost); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOOptimizerStrategyOverrides {\n"); + sb.append(" objective: ").append(toIndentedString(objective)).append("\n"); + sb.append(" constraints: ").append(toIndentedString(constraints)).append("\n"); + sb.append(" alpha: ").append(toIndentedString(alpha)).append("\n"); + sb.append(" transactionCost: ").append(toIndentedString(transactionCost)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java new file mode 100644 index 00000000..4f2cdfad --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * Group + */ +@JsonPropertyOrder({ + Group.JSON_PROPERTY_NAME, + Group.JSON_PROPERTY_DIRECTORY, + Group.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class Group implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public Group name(String name) { + this.name = name; + return this; + } + + /** + * Group Name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Group Name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public Group directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Group Directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Group Directory") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public Group category(String category) { + this.category = category; + return this; + } + + /** + * Group Category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Group Category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this Group object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Group group = (Group) o; + return Objects.equals(this.name, group.name) && + Objects.equals(this.directory, group.directory) && + Objects.equals(this.category, group.category); + } + + @Override + public int hashCode() { + return Objects.hash(name, directory, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Group {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java new file mode 100644 index 00000000..6e03e440 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.Group; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * GroupRoot + */ +@JsonPropertyOrder({ + GroupRoot.JSON_PROPERTY_DATA, + GroupRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class GroupRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public GroupRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public GroupRoot putDataItem(String key, Group dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public GroupRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this GroupRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GroupRoot groupRoot = (GroupRoot) o; + return Objects.equals(this.data, groupRoot.data) && + Objects.equals(this.meta, groupRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class GroupRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java new file mode 100644 index 00000000..a6b394a1 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java @@ -0,0 +1,292 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplate + */ +@JsonPropertyOrder({ + LinkedPATemplate.JSON_PROPERTY_DIRECTORY, + LinkedPATemplate.JSON_PROPERTY_SNAPSHOT, + LinkedPATemplate.JSON_PROPERTY_CONTENT, + LinkedPATemplate.JSON_PROPERTY_ID, + LinkedPATemplate.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplate.JSON_PROPERTY_NAME, + LinkedPATemplate.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplate implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + + public LinkedPATemplate directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Template directory. + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template directory.") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public LinkedPATemplate snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * snapshot. + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "snapshot.") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public LinkedPATemplate content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + public LinkedPATemplate id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public LinkedPATemplate description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplate name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplate parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplate linkedPATemplate = (LinkedPATemplate) o; + return Objects.equals(this.directory, linkedPATemplate.directory) && + Objects.equals(this.snapshot, linkedPATemplate.snapshot) && + Objects.equals(this.content, linkedPATemplate.content) && + Objects.equals(this.id, linkedPATemplate.id) && + Objects.equals(this.description, linkedPATemplate.description) && + Objects.equals(this.name, linkedPATemplate.name) && + Objects.equals(this.parentComponentId, linkedPATemplate.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(directory, snapshot, content, id, description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplate {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java new file mode 100644 index 00000000..5662367c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java @@ -0,0 +1,200 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateParameters + */ +@JsonPropertyOrder({ + LinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, + LinkedPATemplateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, + LinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + + public LinkedPATemplateParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * The directory to create a linked PA template + * @return directory + **/ + @ApiModelProperty(required = true, value = "The directory to create a linked PA template") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public LinkedPATemplateParameters parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Parent component id + * @return parentComponentId + **/ + @ApiModelProperty(required = true, value = "Parent component id") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getParentComponentId() { + return parentComponentId; + } + + + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + public LinkedPATemplateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this LinkedPATemplateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateParameters linkedPATemplateParameters = (LinkedPATemplateParameters) o; + return Objects.equals(this.directory, linkedPATemplateParameters.directory) && + Objects.equals(this.parentComponentId, linkedPATemplateParameters.parentComponentId) && + Objects.equals(this.description, linkedPATemplateParameters.description) && + Objects.equals(this.content, linkedPATemplateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(directory, parentComponentId, description, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java new file mode 100644 index 00000000..6be71c7f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateParametersRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, + LinkedPATemplateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public LinkedPATemplateParametersRoot data(LinkedPATemplateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplateParameters getData() { + return data; + } + + + public void setData(LinkedPATemplateParameters data) { + this.data = data; + } + + + public LinkedPATemplateParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this LinkedPATemplateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = (LinkedPATemplateParametersRoot) o; + return Objects.equals(this.data, linkedPATemplateParametersRoot.data) && + Objects.equals(this.meta, linkedPATemplateParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java new file mode 100644 index 00000000..8312997c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java @@ -0,0 +1,201 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplatePostSummary + */ +@JsonPropertyOrder({ + LinkedPATemplatePostSummary.JSON_PROPERTY_ID, + LinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplatePostSummary.JSON_PROPERTY_NAME, + LinkedPATemplatePostSummary.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplatePostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + + public LinkedPATemplatePostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public LinkedPATemplatePostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplatePostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplatePostSummary parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplatePostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplatePostSummary linkedPATemplatePostSummary = (LinkedPATemplatePostSummary) o; + return Objects.equals(this.id, linkedPATemplatePostSummary.id) && + Objects.equals(this.description, linkedPATemplatePostSummary.description) && + Objects.equals(this.name, linkedPATemplatePostSummary.name) && + Objects.equals(this.parentComponentId, linkedPATemplatePostSummary.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplatePostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java new file mode 100644 index 00000000..67290f3c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplatePostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplatePostSummaryRoot + */ +@JsonPropertyOrder({ + LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, + LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplatePostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplatePostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public LinkedPATemplatePostSummaryRoot data(LinkedPATemplatePostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplatePostSummary getData() { + return data; + } + + + public void setData(LinkedPATemplatePostSummary data) { + this.data = data; + } + + + public LinkedPATemplatePostSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this LinkedPATemplatePostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplatePostSummaryRoot linkedPATemplatePostSummaryRoot = (LinkedPATemplatePostSummaryRoot) o; + return Objects.equals(this.data, linkedPATemplatePostSummaryRoot.data) && + Objects.equals(this.meta, linkedPATemplatePostSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplatePostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java new file mode 100644 index 00000000..18843692 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateRoot.JSON_PROPERTY_DATA, + LinkedPATemplateRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplate data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public LinkedPATemplateRoot data(LinkedPATemplate data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplate getData() { + return data; + } + + + public void setData(LinkedPATemplate data) { + this.data = data; + } + + + public LinkedPATemplateRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this LinkedPATemplateRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateRoot linkedPATemplateRoot = (LinkedPATemplateRoot) o; + return Objects.equals(this.data, linkedPATemplateRoot.data) && + Objects.equals(this.meta, linkedPATemplateRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java new file mode 100644 index 00000000..9f91aa69 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateSummary + */ +@JsonPropertyOrder({ + LinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateSummary.JSON_PROPERTY_NAME, + LinkedPATemplateSummary.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + + public LinkedPATemplateSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplateSummary parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplateSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateSummary linkedPATemplateSummary = (LinkedPATemplateSummary) o; + return Objects.equals(this.description, linkedPATemplateSummary.description) && + Objects.equals(this.name, linkedPATemplateSummary.name) && + Objects.equals(this.parentComponentId, linkedPATemplateSummary.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java new file mode 100644 index 00000000..60bd1858 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateSummaryRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, + LinkedPATemplateSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public LinkedPATemplateSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public LinkedPATemplateSummaryRoot putDataItem(String key, LinkedPATemplateSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public LinkedPATemplateSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this LinkedPATemplateSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateSummaryRoot linkedPATemplateSummaryRoot = (LinkedPATemplateSummaryRoot) o; + return Objects.equals(this.data, linkedPATemplateSummaryRoot.data) && + Objects.equals(this.meta, linkedPATemplateSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java new file mode 100644 index 00000000..5ed2a4d0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java @@ -0,0 +1,172 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateUpdateParameters + */ +@JsonPropertyOrder({ + LinkedPATemplateUpdateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, + LinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + + public LinkedPATemplateUpdateParameters parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Parent component id + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Parent component id") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + public LinkedPATemplateUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateUpdateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this LinkedPATemplateUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateUpdateParameters linkedPATemplateUpdateParameters = (LinkedPATemplateUpdateParameters) o; + return Objects.equals(this.parentComponentId, linkedPATemplateUpdateParameters.parentComponentId) && + Objects.equals(this.description, linkedPATemplateUpdateParameters.description) && + Objects.equals(this.content, linkedPATemplateUpdateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(parentComponentId, description, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateUpdateParameters {\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java new file mode 100644 index 00000000..86e62d88 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateUpdateParametersRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, + LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplateUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public LinkedPATemplateUpdateParametersRoot data(LinkedPATemplateUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplateUpdateParameters getData() { + return data; + } + + + public void setData(LinkedPATemplateUpdateParameters data) { + this.data = data; + } + + + public LinkedPATemplateUpdateParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this LinkedPATemplateUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = (LinkedPATemplateUpdateParametersRoot) o; + return Objects.equals(this.data, linkedPATemplateUpdateParametersRoot.data) && + Objects.equals(this.meta, linkedPATemplateUpdateParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java new file mode 100644 index 00000000..d6521e0c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java @@ -0,0 +1,262 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentaryDate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * Metadata + */ +@JsonPropertyOrder({ + Metadata.JSON_PROPERTY_TILE_NAME, + Metadata.JSON_PROPERTY_PORTFOLIO_DESCRIPTION, + Metadata.JSON_PROPERTY_BENCHMARK_DESCRIPTION, + Metadata.JSON_PROPERTY_START_DATE, + Metadata.JSON_PROPERTY_END_DATE, + Metadata.JSON_PROPERTY_FREQUENCY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class Metadata implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_TILE_NAME = "tileName"; + private String tileName; + + public static final String JSON_PROPERTY_PORTFOLIO_DESCRIPTION = "portfolioDescription"; + private String portfolioDescription; + + public static final String JSON_PROPERTY_BENCHMARK_DESCRIPTION = "benchmarkDescription"; + private String benchmarkDescription; + + public static final String JSON_PROPERTY_START_DATE = "startDate"; + private PACommentaryDate startDate; + + public static final String JSON_PROPERTY_END_DATE = "endDate"; + private PACommentaryDate endDate; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + + public Metadata tileName(String tileName) { + this.tileName = tileName; + return this; + } + + /** + * PA Tile name associated with the component + * @return tileName + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA Tile name associated with the component") + @JsonProperty(JSON_PROPERTY_TILE_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTileName() { + return tileName; + } + + + public void setTileName(String tileName) { + this.tileName = tileName; + } + + + public Metadata portfolioDescription(String portfolioDescription) { + this.portfolioDescription = portfolioDescription; + return this; + } + + /** + * Portfolio name used in generating commentary + * @return portfolioDescription + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Portfolio name used in generating commentary") + @JsonProperty(JSON_PROPERTY_PORTFOLIO_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPortfolioDescription() { + return portfolioDescription; + } + + + public void setPortfolioDescription(String portfolioDescription) { + this.portfolioDescription = portfolioDescription; + } + + + public Metadata benchmarkDescription(String benchmarkDescription) { + this.benchmarkDescription = benchmarkDescription; + return this; + } + + /** + * Benchmark name used in generating commentary + * @return benchmarkDescription + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Benchmark name used in generating commentary") + @JsonProperty(JSON_PROPERTY_BENCHMARK_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getBenchmarkDescription() { + return benchmarkDescription; + } + + + public void setBenchmarkDescription(String benchmarkDescription) { + this.benchmarkDescription = benchmarkDescription; + } + + + public Metadata startDate(PACommentaryDate startDate) { + this.startDate = startDate; + return this; + } + + /** + * Get startDate + * @return startDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACommentaryDate getStartDate() { + return startDate; + } + + + public void setStartDate(PACommentaryDate startDate) { + this.startDate = startDate; + } + + + public Metadata endDate(PACommentaryDate endDate) { + this.endDate = endDate; + return this; + } + + /** + * Get endDate + * @return endDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACommentaryDate getEndDate() { + return endDate; + } + + + public void setEndDate(PACommentaryDate endDate) { + this.endDate = endDate; + } + + + public Metadata frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Date frequency + * @return frequency + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Date frequency") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + /** + * Return true if this Metadata object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Metadata metadata = (Metadata) o; + return Objects.equals(this.tileName, metadata.tileName) && + Objects.equals(this.portfolioDescription, metadata.portfolioDescription) && + Objects.equals(this.benchmarkDescription, metadata.benchmarkDescription) && + Objects.equals(this.startDate, metadata.startDate) && + Objects.equals(this.endDate, metadata.endDate) && + Objects.equals(this.frequency, metadata.frequency); + } + + @Override + public int hashCode() { + return Objects.hash(tileName, portfolioDescription, benchmarkDescription, startDate, endDate, frequency); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Metadata {\n"); + sb.append(" tileName: ").append(toIndentedString(tileName)).append("\n"); + sb.append(" portfolioDescription: ").append(toIndentedString(portfolioDescription)).append("\n"); + sb.append(" benchmarkDescription: ").append(toIndentedString(benchmarkDescription)).append("\n"); + sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java new file mode 100644 index 00000000..dca33ddf --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java @@ -0,0 +1,149 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationColumn + */ +@JsonPropertyOrder({ + PACalculationColumn.JSON_PROPERTY_ID, + PACalculationColumn.JSON_PROPERTY_STATISTICS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationColumn implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_STATISTICS = "statistics"; + private java.util.List statistics = null; + + + public PACalculationColumn id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Column identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Column identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PACalculationColumn statistics(java.util.List statistics) { + this.statistics = statistics; + return this; + } + + public PACalculationColumn addStatisticsItem(String statisticsItem) { + if (this.statistics == null) { + this.statistics = new java.util.ArrayList(); + } + this.statistics.add(statisticsItem); + return this; + } + + /** + * Column Statistic identifier + * @return statistics + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Statistic identifier") + @JsonProperty(JSON_PROPERTY_STATISTICS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getStatistics() { + return statistics; + } + + + public void setStatistics(java.util.List statistics) { + this.statistics = statistics; + } + + + /** + * Return true if this PACalculationColumn object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationColumn paCalculationColumn = (PACalculationColumn) o; + return Objects.equals(this.id, paCalculationColumn.id) && + Objects.equals(this.statistics, paCalculationColumn.statistics); + } + + @Override + public int hashCode() { + return Objects.hash(id, statistics); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationColumn {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" statistics: ").append(toIndentedString(statistics)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java new file mode 100644 index 00000000..08a7f10e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationDataSources.java @@ -0,0 +1,188 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationPricingSource; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationDataSources + */ +@JsonPropertyOrder({ + PACalculationDataSources.JSON_PROPERTY_PORTFOLIOPRICINGSOURCES, + PACalculationDataSources.JSON_PROPERTY_BENCHMARKPRICINGSOURCES, + PACalculationDataSources.JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationDataSources implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PORTFOLIOPRICINGSOURCES = "portfoliopricingsources"; + private java.util.List portfoliopricingsources = null; + + public static final String JSON_PROPERTY_BENCHMARKPRICINGSOURCES = "benchmarkpricingsources"; + private java.util.List benchmarkpricingsources = null; + + public static final String JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK = "useportfoliopricingsourcesforbenchmark"; + private Boolean useportfoliopricingsourcesforbenchmark; + + + public PACalculationDataSources portfoliopricingsources(java.util.List portfoliopricingsources) { + this.portfoliopricingsources = portfoliopricingsources; + return this; + } + + public PACalculationDataSources addPortfoliopricingsourcesItem(PACalculationPricingSource portfoliopricingsourcesItem) { + if (this.portfoliopricingsources == null) { + this.portfoliopricingsources = new java.util.ArrayList(); + } + this.portfoliopricingsources.add(portfoliopricingsourcesItem); + return this; + } + + /** + * List of portfilio pricing source for the PA calculation + * @return portfoliopricingsources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of portfilio pricing source for the PA calculation") + @JsonProperty(JSON_PROPERTY_PORTFOLIOPRICINGSOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getPortfoliopricingsources() { + return portfoliopricingsources; + } + + + public void setPortfoliopricingsources(java.util.List portfoliopricingsources) { + this.portfoliopricingsources = portfoliopricingsources; + } + + + public PACalculationDataSources benchmarkpricingsources(java.util.List benchmarkpricingsources) { + this.benchmarkpricingsources = benchmarkpricingsources; + return this; + } + + public PACalculationDataSources addBenchmarkpricingsourcesItem(PACalculationPricingSource benchmarkpricingsourcesItem) { + if (this.benchmarkpricingsources == null) { + this.benchmarkpricingsources = new java.util.ArrayList(); + } + this.benchmarkpricingsources.add(benchmarkpricingsourcesItem); + return this; + } + + /** + * List of benchmark pricing source for the PA calculation + * @return benchmarkpricingsources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmark pricing source for the PA calculation") + @JsonProperty(JSON_PROPERTY_BENCHMARKPRICINGSOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarkpricingsources() { + return benchmarkpricingsources; + } + + + public void setBenchmarkpricingsources(java.util.List benchmarkpricingsources) { + this.benchmarkpricingsources = benchmarkpricingsources; + } + + + public PACalculationDataSources useportfoliopricingsourcesforbenchmark(Boolean useportfoliopricingsourcesforbenchmark) { + this.useportfoliopricingsourcesforbenchmark = useportfoliopricingsourcesforbenchmark; + return this; + } + + /** + * Use portfolio pricing sources for benchmark + * @return useportfoliopricingsourcesforbenchmark + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Use portfolio pricing sources for benchmark") + @JsonProperty(JSON_PROPERTY_USEPORTFOLIOPRICINGSOURCESFORBENCHMARK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseportfoliopricingsourcesforbenchmark() { + return useportfoliopricingsourcesforbenchmark; + } + + + public void setUseportfoliopricingsourcesforbenchmark(Boolean useportfoliopricingsourcesforbenchmark) { + this.useportfoliopricingsourcesforbenchmark = useportfoliopricingsourcesforbenchmark; + } + + + /** + * Return true if this PACalculationDataSources object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationDataSources paCalculationDataSources = (PACalculationDataSources) o; + return Objects.equals(this.portfoliopricingsources, paCalculationDataSources.portfoliopricingsources) && + Objects.equals(this.benchmarkpricingsources, paCalculationDataSources.benchmarkpricingsources) && + Objects.equals(this.useportfoliopricingsourcesforbenchmark, paCalculationDataSources.useportfoliopricingsourcesforbenchmark); + } + + @Override + public int hashCode() { + return Objects.hash(portfoliopricingsources, benchmarkpricingsources, useportfoliopricingsourcesforbenchmark); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationDataSources {\n"); + sb.append(" portfoliopricingsources: ").append(toIndentedString(portfoliopricingsources)).append("\n"); + sb.append(" benchmarkpricingsources: ").append(toIndentedString(benchmarkpricingsources)).append("\n"); + sb.append(" useportfoliopricingsourcesforbenchmark: ").append(toIndentedString(useportfoliopricingsourcesforbenchmark)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java new file mode 100644 index 00000000..fec5902a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationGroup + */ +@JsonPropertyOrder({ + PACalculationGroup.JSON_PROPERTY_ID, + PACalculationGroup.JSON_PROPERTY_FREQUENCY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationGroup implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + + public PACalculationGroup id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Group identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Group identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PACalculationGroup frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Grouping frequency + * @return frequency + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Grouping frequency") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + /** + * Return true if this PACalculationGroup object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationGroup paCalculationGroup = (PACalculationGroup) o; + return Objects.equals(this.id, paCalculationGroup.id) && + Objects.equals(this.frequency, paCalculationGroup.frequency); + } + + @Override + public int hashCode() { + return Objects.hash(id, frequency); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationGroup {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java new file mode 100644 index 00000000..73ff4f33 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java @@ -0,0 +1,387 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationDataSources; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationParameters + */ +@JsonPropertyOrder({ + PACalculationParameters.JSON_PROPERTY_COMPONENTID, + PACalculationParameters.JSON_PROPERTY_ACCOUNTS, + PACalculationParameters.JSON_PROPERTY_BENCHMARKS, + PACalculationParameters.JSON_PROPERTY_DATES, + PACalculationParameters.JSON_PROPERTY_GROUPS, + PACalculationParameters.JSON_PROPERTY_CURRENCYISOCODE, + PACalculationParameters.JSON_PROPERTY_COLUMNS, + PACalculationParameters.JSON_PROPERTY_DATASOURCES, + PACalculationParameters.JSON_PROPERTY_COMPONENTDETAIL +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_COMPONENTID = "componentid"; + private String componentid; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATASOURCES = "datasources"; + private PACalculationDataSources datasources; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + + public PACalculationParameters componentid(String componentid) { + this.componentid = componentid; + return this; + } + + /** + * The PA Engine component identifier to analyze. + * @return componentid + **/ + @ApiModelProperty(required = true, value = "The PA Engine component identifier to analyze.") + @JsonProperty(JSON_PROPERTY_COMPONENTID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getComponentid() { + return componentid; + } + + + public void setComponentid(String componentid) { + this.componentid = componentid; + } + + + public PACalculationParameters accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public PACalculationParameters addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts. + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts.") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public PACalculationParameters benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public PACalculationParameters addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks. + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks.") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public PACalculationParameters dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public PACalculationParameters groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public PACalculationParameters addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public PACalculationParameters currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public PACalculationParameters columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public PACalculationParameters addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public PACalculationParameters datasources(PACalculationDataSources datasources) { + this.datasources = datasources; + return this; + } + + /** + * Get datasources + * @return datasources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATASOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACalculationDataSources getDatasources() { + return datasources; + } + + + public void setDatasources(PACalculationDataSources datasources) { + this.datasources = datasources; + } + + + public PACalculationParameters componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + /** + * Return true if this PACalculationParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationParameters paCalculationParameters = (PACalculationParameters) o; + return Objects.equals(this.componentid, paCalculationParameters.componentid) && + Objects.equals(this.accounts, paCalculationParameters.accounts) && + Objects.equals(this.benchmarks, paCalculationParameters.benchmarks) && + Objects.equals(this.dates, paCalculationParameters.dates) && + Objects.equals(this.groups, paCalculationParameters.groups) && + Objects.equals(this.currencyisocode, paCalculationParameters.currencyisocode) && + Objects.equals(this.columns, paCalculationParameters.columns) && + Objects.equals(this.datasources, paCalculationParameters.datasources) && + Objects.equals(this.componentdetail, paCalculationParameters.componentdetail); + } + + @Override + public int hashCode() { + return Objects.hash(componentid, accounts, benchmarks, dates, groups, currencyisocode, columns, datasources, componentdetail); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationParameters {\n"); + sb.append(" componentid: ").append(toIndentedString(componentid)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java new file mode 100644 index 00000000..1849ad0f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java @@ -0,0 +1,151 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.CalculationMeta; +import factset.analyticsapi.engines.models.PACalculationParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationParametersRoot + */ +@JsonPropertyOrder({ + PACalculationParametersRoot.JSON_PROPERTY_DATA, + PACalculationParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = null; + + public static final String JSON_PROPERTY_META = "meta"; + private CalculationMeta meta; + + + public PACalculationParametersRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public PACalculationParametersRoot putDataItem(String key, PACalculationParameters dataItem) { + if (this.data == null) { + this.data = new java.util.HashMap(); + } + this.data.put(key, dataItem); + return this; + } + + /** + * List of calculation parameters. + * @return data + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of calculation parameters.") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public PACalculationParametersRoot meta(CalculationMeta meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public CalculationMeta getMeta() { + return meta; + } + + + public void setMeta(CalculationMeta meta) { + this.meta = meta; + } + + + /** + * Return true if this PACalculationParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationParametersRoot paCalculationParametersRoot = (PACalculationParametersRoot) o; + return Objects.equals(this.data, paCalculationParametersRoot.data) && + Objects.equals(this.meta, paCalculationParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java new file mode 100644 index 00000000..298f9dd7 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java @@ -0,0 +1,111 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACalculationPricingSource + */ +@JsonPropertyOrder({ + PACalculationPricingSource.JSON_PROPERTY_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACalculationPricingSource implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + + public PACalculationPricingSource id(String id) { + this.id = id; + return this; + } + + /** + * Pricing source identifier + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Pricing source identifier") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + /** + * Return true if this PACalculationPricingSource object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACalculationPricingSource paCalculationPricingSource = (PACalculationPricingSource) o; + return Objects.equals(this.id, paCalculationPricingSource.id); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACalculationPricingSource {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java new file mode 100644 index 00000000..cc53021e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java @@ -0,0 +1,180 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.Section; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentary + */ +@JsonPropertyOrder({ + PACommentary.JSON_PROPERTY_COMMENTARY_ID, + PACommentary.JSON_PROPERTY_SECTIONS, + PACommentary.JSON_PROPERTY_DISCLAIMER +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_COMMENTARY_ID = "commentaryId"; + private String commentaryId; + + public static final String JSON_PROPERTY_SECTIONS = "sections"; + private java.util.List
sections = null; + + public static final String JSON_PROPERTY_DISCLAIMER = "disclaimer"; + private String disclaimer; + + + public PACommentary commentaryId(String commentaryId) { + this.commentaryId = commentaryId; + return this; + } + + /** + * Generated commentary Id + * @return commentaryId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Generated commentary Id") + @JsonProperty(JSON_PROPERTY_COMMENTARY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCommentaryId() { + return commentaryId; + } + + + public void setCommentaryId(String commentaryId) { + this.commentaryId = commentaryId; + } + + + public PACommentary sections(java.util.List
sections) { + this.sections = sections; + return this; + } + + public PACommentary addSectionsItem(Section sectionsItem) { + if (this.sections == null) { + this.sections = new java.util.ArrayList
(); + } + this.sections.add(sectionsItem); + return this; + } + + /** + * Commentary sections + * @return sections + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Commentary sections") + @JsonProperty(JSON_PROPERTY_SECTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List
getSections() { + return sections; + } + + + public void setSections(java.util.List
sections) { + this.sections = sections; + } + + + public PACommentary disclaimer(String disclaimer) { + this.disclaimer = disclaimer; + return this; + } + + /** + * Disclaimer + * @return disclaimer + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Disclaimer") + @JsonProperty(JSON_PROPERTY_DISCLAIMER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDisclaimer() { + return disclaimer; + } + + + public void setDisclaimer(String disclaimer) { + this.disclaimer = disclaimer; + } + + + /** + * Return true if this PACommentary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentary paCommentary = (PACommentary) o; + return Objects.equals(this.commentaryId, paCommentary.commentaryId) && + Objects.equals(this.sections, paCommentary.sections) && + Objects.equals(this.disclaimer, paCommentary.disclaimer); + } + + @Override + public int hashCode() { + return Objects.hash(commentaryId, sections, disclaimer); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentary {\n"); + sb.append(" commentaryId: ").append(toIndentedString(commentaryId)).append("\n"); + sb.append(" sections: ").append(toIndentedString(sections)).append("\n"); + sb.append(" disclaimer: ").append(toIndentedString(disclaimer)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java new file mode 100644 index 00000000..50c73430 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryConfigurationSummary + */ +@JsonPropertyOrder({ + PACommentaryConfigurationSummary.JSON_PROPERTY_NAME, + PACommentaryConfigurationSummary.JSON_PROPERTY_DIRECTORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryConfigurationSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + + public PACommentaryConfigurationSummary name(String name) { + this.name = name; + return this; + } + + /** + * PA commentary configuration name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA commentary configuration name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PACommentaryConfigurationSummary directory(String directory) { + this.directory = directory; + return this; + } + + /** + * PA Commentary configuration directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA Commentary configuration directory") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + /** + * Return true if this PACommentaryConfigurationSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryConfigurationSummary paCommentaryConfigurationSummary = (PACommentaryConfigurationSummary) o; + return Objects.equals(this.name, paCommentaryConfigurationSummary.name) && + Objects.equals(this.directory, paCommentaryConfigurationSummary.directory); + } + + @Override + public int hashCode() { + return Objects.hash(name, directory); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryConfigurationSummary {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java new file mode 100644 index 00000000..594419ee --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentaryConfigurationSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryConfigurationSummaryRoot + */ +@JsonPropertyOrder({ + PACommentaryConfigurationSummaryRoot.JSON_PROPERTY_DATA, + PACommentaryConfigurationSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryConfigurationSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PACommentaryConfigurationSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public PACommentaryConfigurationSummaryRoot putDataItem(String key, PACommentaryConfigurationSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public PACommentaryConfigurationSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PACommentaryConfigurationSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryConfigurationSummaryRoot paCommentaryConfigurationSummaryRoot = (PACommentaryConfigurationSummaryRoot) o; + return Objects.equals(this.data, paCommentaryConfigurationSummaryRoot.data) && + Objects.equals(this.meta, paCommentaryConfigurationSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryConfigurationSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java new file mode 100644 index 00000000..cb8320d2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryDate + */ +@JsonPropertyOrder({ + PACommentaryDate.JSON_PROPERTY_YYYYMMDD, + PACommentaryDate.JSON_PROPERTY_RELATIVE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryDate implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_YYYYMMDD = "yyyymmdd"; + private Integer yyyymmdd; + + public static final String JSON_PROPERTY_RELATIVE = "relative"; + private String relative; + + + public PACommentaryDate yyyymmdd(Integer yyyymmdd) { + this.yyyymmdd = yyyymmdd; + return this; + } + + /** + * Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. + * @return yyyymmdd + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time.") + @JsonProperty(JSON_PROPERTY_YYYYMMDD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getYyyymmdd() { + return yyyymmdd; + } + + + public void setYyyymmdd(Integer yyyymmdd) { + this.yyyymmdd = yyyymmdd; + } + + + public PACommentaryDate relative(String relative) { + this.relative = relative; + return this; + } + + /** + * Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. + * @return relative + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time.") + @JsonProperty(JSON_PROPERTY_RELATIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRelative() { + return relative; + } + + + public void setRelative(String relative) { + this.relative = relative; + } + + + /** + * Return true if this PACommentaryDate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryDate paCommentaryDate = (PACommentaryDate) o; + return Objects.equals(this.yyyymmdd, paCommentaryDate.yyyymmdd) && + Objects.equals(this.relative, paCommentaryDate.relative); + } + + @Override + public int hashCode() { + return Objects.hash(yyyymmdd, relative); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryDate {\n"); + sb.append(" yyyymmdd: ").append(toIndentedString(yyyymmdd)).append("\n"); + sb.append(" relative: ").append(toIndentedString(relative)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java new file mode 100644 index 00000000..acdc2fa6 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java @@ -0,0 +1,206 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryGetStatus + */ +@JsonPropertyOrder({ + PACommentaryGetStatus.JSON_PROPERTY_CALCULATIONID, + PACommentaryGetStatus.JSON_PROPERTY_UNITID, + PACommentaryGetStatus.JSON_PROPERTY_STATUS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryGetStatus implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_CALCULATIONID = "calculationid"; + private String calculationid; + + public static final String JSON_PROPERTY_UNITID = "unitid"; + private String unitid; + + /** + * The status of commentary generation. + */ + public enum StatusEnum { + EXECUTING("Executing"), + + SUCCESS("Success"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusEnum fromValue(String value) { + for (StatusEnum b : StatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS = "status"; + private StatusEnum status; + + + public PACommentaryGetStatus calculationid(String calculationid) { + this.calculationid = calculationid; + return this; + } + + /** + * Calculation id. + * @return calculationid + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Calculation id.") + @JsonProperty(JSON_PROPERTY_CALCULATIONID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCalculationid() { + return calculationid; + } + + + public void setCalculationid(String calculationid) { + this.calculationid = calculationid; + } + + + public PACommentaryGetStatus unitid(String unitid) { + this.unitid = unitid; + return this; + } + + /** + * Calculation unit id. + * @return unitid + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Calculation unit id.") + @JsonProperty(JSON_PROPERTY_UNITID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getUnitid() { + return unitid; + } + + + public void setUnitid(String unitid) { + this.unitid = unitid; + } + + + public PACommentaryGetStatus status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The status of commentary generation. + * @return status + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The status of commentary generation.") + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public StatusEnum getStatus() { + return status; + } + + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + /** + * Return true if this PACommentaryGetStatus object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryGetStatus paCommentaryGetStatus = (PACommentaryGetStatus) o; + return Objects.equals(this.calculationid, paCommentaryGetStatus.calculationid) && + Objects.equals(this.unitid, paCommentaryGetStatus.unitid) && + Objects.equals(this.status, paCommentaryGetStatus.status); + } + + @Override + public int hashCode() { + return Objects.hash(calculationid, unitid, status); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryGetStatus {\n"); + sb.append(" calculationid: ").append(toIndentedString(calculationid)).append("\n"); + sb.append(" unitid: ").append(toIndentedString(unitid)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java new file mode 100644 index 00000000..595b259b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentaryGetStatus; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryGetStatusRoot + */ +@JsonPropertyOrder({ + PACommentaryGetStatusRoot.JSON_PROPERTY_DATA, + PACommentaryGetStatusRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryGetStatusRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private PACommentaryGetStatus data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PACommentaryGetStatusRoot data(PACommentaryGetStatus data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PACommentaryGetStatus getData() { + return data; + } + + + public void setData(PACommentaryGetStatus data) { + this.data = data; + } + + + public PACommentaryGetStatusRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PACommentaryGetStatusRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryGetStatusRoot paCommentaryGetStatusRoot = (PACommentaryGetStatusRoot) o; + return Objects.equals(this.data, paCommentaryGetStatusRoot.data) && + Objects.equals(this.meta, paCommentaryGetStatusRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryGetStatusRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java new file mode 100644 index 00000000..093f8792 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java @@ -0,0 +1,111 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryParameters + */ +@JsonPropertyOrder({ + PACommentaryParameters.JSON_PROPERTY_CONFIGURATIONID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_CONFIGURATIONID = "configurationid"; + private String configurationid; + + + public PACommentaryParameters configurationid(String configurationid) { + this.configurationid = configurationid; + return this; + } + + /** + * Commentary configuration id + * @return configurationid + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Commentary configuration id") + @JsonProperty(JSON_PROPERTY_CONFIGURATIONID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getConfigurationid() { + return configurationid; + } + + + public void setConfigurationid(String configurationid) { + this.configurationid = configurationid; + } + + + /** + * Return true if this PACommentaryParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryParameters paCommentaryParameters = (PACommentaryParameters) o; + return Objects.equals(this.configurationid, paCommentaryParameters.configurationid); + } + + @Override + public int hashCode() { + return Objects.hash(configurationid); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryParameters {\n"); + sb.append(" configurationid: ").append(toIndentedString(configurationid)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java new file mode 100644 index 00000000..5658526f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentaryParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryParametersRoot + */ +@JsonPropertyOrder({ + PACommentaryParametersRoot.JSON_PROPERTY_DATA, + PACommentaryParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private PACommentaryParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PACommentaryParametersRoot data(PACommentaryParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PACommentaryParameters getData() { + return data; + } + + + public void setData(PACommentaryParameters data) { + this.data = data; + } + + + public PACommentaryParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PACommentaryParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryParametersRoot paCommentaryParametersRoot = (PACommentaryParametersRoot) o; + return Objects.equals(this.data, paCommentaryParametersRoot.data) && + Objects.equals(this.meta, paCommentaryParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java new file mode 100644 index 00000000..0bf8a87a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryRoot + */ +@JsonPropertyOrder({ + PACommentaryRoot.JSON_PROPERTY_DATA, + PACommentaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private PACommentary data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PACommentaryRoot data(PACommentary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PACommentary getData() { + return data; + } + + + public void setData(PACommentary data) { + this.data = data; + } + + + public PACommentaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PACommentaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryRoot paCommentaryRoot = (PACommentaryRoot) o; + return Objects.equals(this.data, paCommentaryRoot.data) && + Objects.equals(this.meta, paCommentaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java new file mode 100644 index 00000000..6a0daae9 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java @@ -0,0 +1,236 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryStatus + */ +@JsonPropertyOrder({ + PACommentaryStatus.JSON_PROPERTY_RESULT, + PACommentaryStatus.JSON_PROPERTY_CALCULATIONID, + PACommentaryStatus.JSON_PROPERTY_UNITID, + PACommentaryStatus.JSON_PROPERTY_STATUS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryStatus implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_RESULT = "result"; + private String result; + + public static final String JSON_PROPERTY_CALCULATIONID = "calculationid"; + private String calculationid; + + public static final String JSON_PROPERTY_UNITID = "unitid"; + private String unitid; + + /** + * The status of commentary generation. + */ + public enum StatusEnum { + EXECUTING("Executing"), + + SUCCESS("Success"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusEnum fromValue(String value) { + for (StatusEnum b : StatusEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS = "status"; + private StatusEnum status; + + + public PACommentaryStatus result(String result) { + this.result = result; + return this; + } + + /** + * The result url of the generated commentary. + * @return result + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The result url of the generated commentary.") + @JsonProperty(JSON_PROPERTY_RESULT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getResult() { + return result; + } + + + public void setResult(String result) { + this.result = result; + } + + + public PACommentaryStatus calculationid(String calculationid) { + this.calculationid = calculationid; + return this; + } + + /** + * Calculation id. + * @return calculationid + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Calculation id.") + @JsonProperty(JSON_PROPERTY_CALCULATIONID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCalculationid() { + return calculationid; + } + + + public void setCalculationid(String calculationid) { + this.calculationid = calculationid; + } + + + public PACommentaryStatus unitid(String unitid) { + this.unitid = unitid; + return this; + } + + /** + * Calculation unit id. + * @return unitid + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Calculation unit id.") + @JsonProperty(JSON_PROPERTY_UNITID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getUnitid() { + return unitid; + } + + + public void setUnitid(String unitid) { + this.unitid = unitid; + } + + + public PACommentaryStatus status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The status of commentary generation. + * @return status + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The status of commentary generation.") + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public StatusEnum getStatus() { + return status; + } + + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + /** + * Return true if this PACommentaryStatus object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryStatus paCommentaryStatus = (PACommentaryStatus) o; + return Objects.equals(this.result, paCommentaryStatus.result) && + Objects.equals(this.calculationid, paCommentaryStatus.calculationid) && + Objects.equals(this.unitid, paCommentaryStatus.unitid) && + Objects.equals(this.status, paCommentaryStatus.status); + } + + @Override + public int hashCode() { + return Objects.hash(result, calculationid, unitid, status); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryStatus {\n"); + sb.append(" result: ").append(toIndentedString(result)).append("\n"); + sb.append(" calculationid: ").append(toIndentedString(calculationid)).append("\n"); + sb.append(" unitid: ").append(toIndentedString(unitid)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java new file mode 100644 index 00000000..ea93fc1a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACommentaryStatus; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PACommentaryStatusRoot + */ +@JsonPropertyOrder({ + PACommentaryStatusRoot.JSON_PROPERTY_DATA, + PACommentaryStatusRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PACommentaryStatusRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private PACommentaryStatus data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PACommentaryStatusRoot data(PACommentaryStatus data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PACommentaryStatus getData() { + return data; + } + + + public void setData(PACommentaryStatus data) { + this.data = data; + } + + + public PACommentaryStatusRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PACommentaryStatusRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PACommentaryStatusRoot paCommentaryStatusRoot = (PACommentaryStatusRoot) o; + return Objects.equals(this.data, paCommentaryStatusRoot.data) && + Objects.equals(this.meta, paCommentaryStatusRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PACommentaryStatusRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java new file mode 100644 index 00000000..5598661f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java @@ -0,0 +1,369 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAComponent + */ +@JsonPropertyOrder({ + PAComponent.JSON_PROPERTY_ID, + PAComponent.JSON_PROPERTY_ACCOUNTS, + PAComponent.JSON_PROPERTY_BENCHMARKS, + PAComponent.JSON_PROPERTY_CURRENCYISOCODE, + PAComponent.JSON_PROPERTY_DATES, + PAComponent.JSON_PROPERTY_SNAPSHOT, + PAComponent.JSON_PROPERTY_PATH, + PAComponent.JSON_PROPERTY_NAME, + PAComponent.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAComponent implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_PATH = "path"; + private String path; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public PAComponent id(String id) { + this.id = id; + return this; + } + + /** + * Component identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PAComponent accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public PAComponent addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts saved in the PA document. + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts saved in the PA document.") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public PAComponent benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public PAComponent addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks saved in the PA document. + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks saved in the PA document.") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public PAComponent currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Get currencyisocode + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public PAComponent dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public PAComponent snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * Is the component type snapshot or subperiod. + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Is the component type snapshot or subperiod.") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public PAComponent path(String path) { + this.path = path; + return this; + } + + /** + * The path to the document + * @return path + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The path to the document") + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPath() { + return path; + } + + + public void setPath(String path) { + this.path = path; + } + + + public PAComponent name(String name) { + this.name = name; + return this; + } + + /** + * Component name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PAComponent category(String category) { + this.category = category; + return this; + } + + /** + * Component category. + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component category.") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this PAComponent object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAComponent paComponent = (PAComponent) o; + return Objects.equals(this.id, paComponent.id) && + Objects.equals(this.accounts, paComponent.accounts) && + Objects.equals(this.benchmarks, paComponent.benchmarks) && + Objects.equals(this.currencyisocode, paComponent.currencyisocode) && + Objects.equals(this.dates, paComponent.dates) && + Objects.equals(this.snapshot, paComponent.snapshot) && + Objects.equals(this.path, paComponent.path) && + Objects.equals(this.name, paComponent.name) && + Objects.equals(this.category, paComponent.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, accounts, benchmarks, currencyisocode, dates, snapshot, path, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAComponent {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java new file mode 100644 index 00000000..4ef3d796 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java @@ -0,0 +1,358 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationDataSources; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAComponentData + */ +@JsonPropertyOrder({ + PAComponentData.JSON_PROPERTY_ACCOUNTS, + PAComponentData.JSON_PROPERTY_BENCHMARKS, + PAComponentData.JSON_PROPERTY_GROUPS, + PAComponentData.JSON_PROPERTY_COLUMNS, + PAComponentData.JSON_PROPERTY_DATES, + PAComponentData.JSON_PROPERTY_DATASOURCES, + PAComponentData.JSON_PROPERTY_CURRENCYISOCODE, + PAComponentData.JSON_PROPERTY_COMPONENTDETAIL +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAComponentData implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_DATASOURCES = "datasources"; + private PACalculationDataSources datasources; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + + public PAComponentData accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public PAComponentData addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts. + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts.") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public PAComponentData benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public PAComponentData addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks. + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks.") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public PAComponentData groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public PAComponentData addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public PAComponentData columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public PAComponentData addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public PAComponentData dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public PAComponentData datasources(PACalculationDataSources datasources) { + this.datasources = datasources; + return this; + } + + /** + * Get datasources + * @return datasources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATASOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACalculationDataSources getDatasources() { + return datasources; + } + + + public void setDatasources(PACalculationDataSources datasources) { + this.datasources = datasources; + } + + + public PAComponentData currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public PAComponentData componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + /** + * Return true if this PAComponentData object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAComponentData paComponentData = (PAComponentData) o; + return Objects.equals(this.accounts, paComponentData.accounts) && + Objects.equals(this.benchmarks, paComponentData.benchmarks) && + Objects.equals(this.groups, paComponentData.groups) && + Objects.equals(this.columns, paComponentData.columns) && + Objects.equals(this.dates, paComponentData.dates) && + Objects.equals(this.datasources, paComponentData.datasources) && + Objects.equals(this.currencyisocode, paComponentData.currencyisocode) && + Objects.equals(this.componentdetail, paComponentData.componentdetail); + } + + @Override + public int hashCode() { + return Objects.hash(accounts, benchmarks, groups, columns, dates, datasources, currencyisocode, componentdetail); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAComponentData {\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java new file mode 100644 index 00000000..558256c6 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponent; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAComponentRoot + */ +@JsonPropertyOrder({ + PAComponentRoot.JSON_PROPERTY_DATA, + PAComponentRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAComponentRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private PAComponent data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PAComponentRoot data(PAComponent data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public PAComponent getData() { + return data; + } + + + public void setData(PAComponent data) { + this.data = data; + } + + + public PAComponentRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PAComponentRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAComponentRoot paComponentRoot = (PAComponentRoot) o; + return Objects.equals(this.data, paComponentRoot.data) && + Objects.equals(this.meta, paComponentRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAComponentRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java new file mode 100644 index 00000000..d9f70d81 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java @@ -0,0 +1,170 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * The date parameters for PA calculation. + */ +@ApiModel(description = "The date parameters for PA calculation.") +@JsonPropertyOrder({ + PADateParameters.JSON_PROPERTY_STARTDATE, + PADateParameters.JSON_PROPERTY_ENDDATE, + PADateParameters.JSON_PROPERTY_FREQUENCY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PADateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_STARTDATE = "startdate"; + private String startdate; + + public static final String JSON_PROPERTY_ENDDATE = "enddate"; + private String enddate; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + + public PADateParameters startdate(String startdate) { + this.startdate = startdate; + return this; + } + + /** + * Calculation's start date. + * @return startdate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Calculation's start date.") + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStartdate() { + return startdate; + } + + + public void setStartdate(String startdate) { + this.startdate = startdate; + } + + + public PADateParameters enddate(String enddate) { + this.enddate = enddate; + return this; + } + + /** + * Calculation's end date. + * @return enddate + **/ + @ApiModelProperty(required = true, value = "Calculation's end date.") + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getEnddate() { + return enddate; + } + + + public void setEnddate(String enddate) { + this.enddate = enddate; + } + + + public PADateParameters frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Calculation's frequency. + * @return frequency + **/ + @ApiModelProperty(required = true, value = "Calculation's frequency.") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + /** + * Return true if this PADateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PADateParameters paDateParameters = (PADateParameters) o; + return Objects.equals(this.startdate, paDateParameters.startdate) && + Objects.equals(this.enddate, paDateParameters.enddate) && + Objects.equals(this.frequency, paDateParameters.frequency); + } + + @Override + public int hashCode() { + return Objects.hash(startdate, enddate, frequency); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PADateParameters {\n"); + sb.append(" startdate: ").append(toIndentedString(startdate)).append("\n"); + sb.append(" enddate: ").append(toIndentedString(enddate)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java new file mode 100644 index 00000000..c9c910b0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java @@ -0,0 +1,140 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAIdentifier + */ +@JsonPropertyOrder({ + PAIdentifier.JSON_PROPERTY_ID, + PAIdentifier.JSON_PROPERTY_HOLDINGSMODE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAIdentifier implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_HOLDINGSMODE = "holdingsmode"; + private String holdingsmode; + + + public PAIdentifier id(String id) { + this.id = id; + return this; + } + + /** + * User's FactSet account path OR benchmark. + * @return id + **/ + @ApiModelProperty(required = true, value = "User's FactSet account path OR benchmark.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PAIdentifier holdingsmode(String holdingsmode) { + this.holdingsmode = holdingsmode; + return this; + } + + /** + * Holdings Mode can be B&H, TBR, OMS , EXT or VLT. + * @return holdingsmode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Holdings Mode can be B&H, TBR, OMS , EXT or VLT.") + @JsonProperty(JSON_PROPERTY_HOLDINGSMODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getHoldingsmode() { + return holdingsmode; + } + + + public void setHoldingsmode(String holdingsmode) { + this.holdingsmode = holdingsmode; + } + + + /** + * Return true if this PAIdentifier object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAIdentifier paIdentifier = (PAIdentifier) o; + return Objects.equals(this.id, paIdentifier.id) && + Objects.equals(this.holdingsmode, paIdentifier.holdingsmode); + } + + @Override + public int hashCode() { + return Objects.hash(id, holdingsmode); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAIdentifier {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" holdingsmode: ").append(toIndentedString(holdingsmode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java new file mode 100644 index 00000000..6dca9031 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSource.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAPricingSource + */ +@JsonPropertyOrder({ + PAPricingSource.JSON_PROPERTY_NAME, + PAPricingSource.JSON_PROPERTY_DIRECTORY, + PAPricingSource.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAPricingSource implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public PAPricingSource name(String name) { + this.name = name; + return this; + } + + /** + * Pricing source Name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Pricing source Name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PAPricingSource directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Pricing source directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Pricing source directory") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public PAPricingSource category(String category) { + this.category = category; + return this; + } + + /** + * Pricing source category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Pricing source category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this PAPricingSource object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAPricingSource paPricingSource = (PAPricingSource) o; + return Objects.equals(this.name, paPricingSource.name) && + Objects.equals(this.directory, paPricingSource.directory) && + Objects.equals(this.category, paPricingSource.category); + } + + @Override + public int hashCode() { + return Objects.hash(name, directory, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAPricingSource {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java new file mode 100644 index 00000000..098ec800 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAPricingSourceRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAPricingSource; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAPricingSourceRoot + */ +@JsonPropertyOrder({ + PAPricingSourceRoot.JSON_PROPERTY_DATA, + PAPricingSourceRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAPricingSourceRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public PAPricingSourceRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public PAPricingSourceRoot putDataItem(String key, PAPricingSource dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public PAPricingSourceRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this PAPricingSourceRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAPricingSourceRoot paPricingSourceRoot = (PAPricingSourceRoot) o; + return Objects.equals(this.data, paPricingSourceRoot.data) && + Objects.equals(this.meta, paPricingSourceRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAPricingSourceRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java new file mode 100644 index 00000000..84d59278 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java @@ -0,0 +1,110 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PaDoc + */ +@JsonPropertyOrder({ + PaDoc.JSON_PROPERTY_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PaDoc implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + + public PaDoc id(String id) { + this.id = id; + return this; + } + + /** + * PA document path + * @return id + **/ + @ApiModelProperty(required = true, value = "PA document path") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + /** + * Return true if this PaDoc object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PaDoc paDoc = (PaDoc) o; + return Objects.equals(this.id, paDoc.id); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PaDoc {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java new file mode 100644 index 00000000..e5dc6ef6 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java @@ -0,0 +1,210 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.Metadata; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * Section + */ +@JsonPropertyOrder({ + Section.JSON_PROPERTY_METADATA, + Section.JSON_PROPERTY_TITLE, + Section.JSON_PROPERTY_CONTENT, + Section.JSON_PROPERTY_SUB_SECTIONS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class Section implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Metadata metadata; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private String content; + + public static final String JSON_PROPERTY_SUB_SECTIONS = "subSections"; + private java.util.List
subSections = null; + + + public Section metadata(Metadata metadata) { + this.metadata = metadata; + return this; + } + + /** + * Get metadata + * @return metadata + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Metadata getMetadata() { + return metadata; + } + + + public void setMetadata(Metadata metadata) { + this.metadata = metadata; + } + + + public Section title(String title) { + this.title = title; + return this; + } + + /** + * Commentary title + * @return title + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Commentary title") + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + public void setTitle(String title) { + this.title = title; + } + + + public Section content(String content) { + this.content = content; + return this; + } + + /** + * Generated commentary content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Generated commentary content") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getContent() { + return content; + } + + + public void setContent(String content) { + this.content = content; + } + + + public Section subSections(java.util.List
subSections) { + this.subSections = subSections; + return this; + } + + public Section addSubSectionsItem(Section subSectionsItem) { + if (this.subSections == null) { + this.subSections = new java.util.ArrayList
(); + } + this.subSections.add(subSectionsItem); + return this; + } + + /** + * Generated commentary subsections + * @return subSections + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Generated commentary subsections") + @JsonProperty(JSON_PROPERTY_SUB_SECTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List
getSubSections() { + return subSections; + } + + + public void setSubSections(java.util.List
subSections) { + this.subSections = subSections; + } + + + /** + * Return true if this Section object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Section section = (Section) o; + return Objects.equals(this.metadata, section.metadata) && + Objects.equals(this.title, section.title) && + Objects.equals(this.content, section.content) && + Objects.equals(this.subSections, section.subSections); + } + + @Override + public int hashCode() { + return Objects.hash(metadata, title, content, subSections); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Section {\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append(" subSections: ").append(toIndentedString(subSections)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java new file mode 100644 index 00000000..8265863e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java @@ -0,0 +1,195 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplateContentTypes + */ +@JsonPropertyOrder({ + TemplateContentTypes.JSON_PROPERTY_MANDATORY, + TemplateContentTypes.JSON_PROPERTY_OPTIONAL, + TemplateContentTypes.JSON_PROPERTY_LOCKED +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplateContentTypes implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_MANDATORY = "mandatory"; + private java.util.List mandatory = null; + + public static final String JSON_PROPERTY_OPTIONAL = "optional"; + private java.util.List optional = null; + + public static final String JSON_PROPERTY_LOCKED = "locked"; + private java.util.List locked = null; + + + public TemplateContentTypes mandatory(java.util.List mandatory) { + this.mandatory = mandatory; + return this; + } + + public TemplateContentTypes addMandatoryItem(String mandatoryItem) { + if (this.mandatory == null) { + this.mandatory = new java.util.ArrayList(); + } + this.mandatory.add(mandatoryItem); + return this; + } + + /** + * Template mandatory fields + * @return mandatory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template mandatory fields") + @JsonProperty(JSON_PROPERTY_MANDATORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getMandatory() { + return mandatory; + } + + + public void setMandatory(java.util.List mandatory) { + this.mandatory = mandatory; + } + + + public TemplateContentTypes optional(java.util.List optional) { + this.optional = optional; + return this; + } + + public TemplateContentTypes addOptionalItem(String optionalItem) { + if (this.optional == null) { + this.optional = new java.util.ArrayList(); + } + this.optional.add(optionalItem); + return this; + } + + /** + * Template optional fields + * @return optional + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template optional fields") + @JsonProperty(JSON_PROPERTY_OPTIONAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getOptional() { + return optional; + } + + + public void setOptional(java.util.List optional) { + this.optional = optional; + } + + + public TemplateContentTypes locked(java.util.List locked) { + this.locked = locked; + return this; + } + + public TemplateContentTypes addLockedItem(String lockedItem) { + if (this.locked == null) { + this.locked = new java.util.ArrayList(); + } + this.locked.add(lockedItem); + return this; + } + + /** + * Template locked fields + * @return locked + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template locked fields") + @JsonProperty(JSON_PROPERTY_LOCKED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getLocked() { + return locked; + } + + + public void setLocked(java.util.List locked) { + this.locked = locked; + } + + + /** + * Return true if this TemplateContentTypes object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplateContentTypes templateContentTypes = (TemplateContentTypes) o; + return Objects.equals(this.mandatory, templateContentTypes.mandatory) && + Objects.equals(this.optional, templateContentTypes.optional) && + Objects.equals(this.locked, templateContentTypes.locked); + } + + @Override + public int hashCode() { + return Objects.hash(mandatory, optional, locked); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplateContentTypes {\n"); + sb.append(" mandatory: ").append(toIndentedString(mandatory)).append("\n"); + sb.append(" optional: ").append(toIndentedString(optional)).append("\n"); + sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java new file mode 100644 index 00000000..67b2dc3d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java @@ -0,0 +1,322 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponent + */ +@JsonPropertyOrder({ + TemplatedPAComponent.JSON_PROPERTY_ID, + TemplatedPAComponent.JSON_PROPERTY_DIRECTORY, + TemplatedPAComponent.JSON_PROPERTY_SNAPSHOT, + TemplatedPAComponent.JSON_PROPERTY_COMPONENT_DATA, + TemplatedPAComponent.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponent.JSON_PROPERTY_NAME, + TemplatedPAComponent.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponent.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponent implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + + public TemplatedPAComponent id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public TemplatedPAComponent directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Get directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public TemplatedPAComponent snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * Get snapshot + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public TemplatedPAComponent componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + public TemplatedPAComponent description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponent name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponent parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponent type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponent object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponent templatedPAComponent = (TemplatedPAComponent) o; + return Objects.equals(this.id, templatedPAComponent.id) && + Objects.equals(this.directory, templatedPAComponent.directory) && + Objects.equals(this.snapshot, templatedPAComponent.snapshot) && + Objects.equals(this.componentData, templatedPAComponent.componentData) && + Objects.equals(this.description, templatedPAComponent.description) && + Objects.equals(this.name, templatedPAComponent.name) && + Objects.equals(this.parentTemplateId, templatedPAComponent.parentTemplateId) && + Objects.equals(this.type, templatedPAComponent.type); + } + + @Override + public int hashCode() { + return Objects.hash(id, directory, snapshot, componentData, description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponent {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java new file mode 100644 index 00000000..4b3b8e34 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java @@ -0,0 +1,200 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentParameters + */ +@JsonPropertyOrder({ + TemplatedPAComponentParameters.JSON_PROPERTY_DIRECTORY, + TemplatedPAComponentParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentParameters.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentParameters.JSON_PROPERTY_COMPONENT_DATA +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + + public TemplatedPAComponentParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Directory to create templated components + * @return directory + **/ + @ApiModelProperty(required = true, value = "Directory to create templated components") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public TemplatedPAComponentParameters parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Parent template id + * @return parentTemplateId + **/ + @ApiModelProperty(required = true, value = "Parent template id") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentParameters description(String description) { + this.description = description; + return this; + } + + /** + * Component description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentParameters componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + /** + * Return true if this TemplatedPAComponentParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentParameters templatedPAComponentParameters = (TemplatedPAComponentParameters) o; + return Objects.equals(this.directory, templatedPAComponentParameters.directory) && + Objects.equals(this.parentTemplateId, templatedPAComponentParameters.parentTemplateId) && + Objects.equals(this.description, templatedPAComponentParameters.description) && + Objects.equals(this.componentData, templatedPAComponentParameters.componentData); + } + + @Override + public int hashCode() { + return Objects.hash(directory, parentTemplateId, description, componentData); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java new file mode 100644 index 00000000..ec60b30c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentParametersRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentParametersRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public TemplatedPAComponentParametersRoot data(TemplatedPAComponentParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentParameters getData() { + return data; + } + + + public void setData(TemplatedPAComponentParameters data) { + this.data = data; + } + + + public TemplatedPAComponentParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this TemplatedPAComponentParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = (TemplatedPAComponentParametersRoot) o; + return Objects.equals(this.data, templatedPAComponentParametersRoot.data) && + Objects.equals(this.meta, templatedPAComponentParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java new file mode 100644 index 00000000..9e14bfdc --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java @@ -0,0 +1,231 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentPostSummary + */ +@JsonPropertyOrder({ + TemplatedPAComponentPostSummary.JSON_PROPERTY_ID, + TemplatedPAComponentPostSummary.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentPostSummary.JSON_PROPERTY_NAME, + TemplatedPAComponentPostSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentPostSummary.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentPostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + + public TemplatedPAComponentPostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public TemplatedPAComponentPostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentPostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponentPostSummary parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentPostSummary type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponentPostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentPostSummary templatedPAComponentPostSummary = (TemplatedPAComponentPostSummary) o; + return Objects.equals(this.id, templatedPAComponentPostSummary.id) && + Objects.equals(this.description, templatedPAComponentPostSummary.description) && + Objects.equals(this.name, templatedPAComponentPostSummary.name) && + Objects.equals(this.parentTemplateId, templatedPAComponentPostSummary.parentTemplateId) && + Objects.equals(this.type, templatedPAComponentPostSummary.type); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentPostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java new file mode 100644 index 00000000..ebfed98a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentPostSummaryRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentPostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentPostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public TemplatedPAComponentPostSummaryRoot data(TemplatedPAComponentPostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentPostSummary getData() { + return data; + } + + + public void setData(TemplatedPAComponentPostSummary data) { + this.data = data; + } + + + public TemplatedPAComponentPostSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this TemplatedPAComponentPostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentPostSummaryRoot templatedPAComponentPostSummaryRoot = (TemplatedPAComponentPostSummaryRoot) o; + return Objects.equals(this.data, templatedPAComponentPostSummaryRoot.data) && + Objects.equals(this.meta, templatedPAComponentPostSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentPostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java new file mode 100644 index 00000000..888730a3 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponent; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponent data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public TemplatedPAComponentRoot data(TemplatedPAComponent data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponent getData() { + return data; + } + + + public void setData(TemplatedPAComponent data) { + this.data = data; + } + + + public TemplatedPAComponentRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this TemplatedPAComponentRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentRoot templatedPAComponentRoot = (TemplatedPAComponentRoot) o; + return Objects.equals(this.data, templatedPAComponentRoot.data) && + Objects.equals(this.meta, templatedPAComponentRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java new file mode 100644 index 00000000..eda156c8 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java @@ -0,0 +1,201 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentSummary + */ +@JsonPropertyOrder({ + TemplatedPAComponentSummary.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentSummary.JSON_PROPERTY_NAME, + TemplatedPAComponentSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentSummary.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + + public TemplatedPAComponentSummary description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentSummary name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponentSummary parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentSummary type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponentSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentSummary templatedPAComponentSummary = (TemplatedPAComponentSummary) o; + return Objects.equals(this.description, templatedPAComponentSummary.description) && + Objects.equals(this.name, templatedPAComponentSummary.name) && + Objects.equals(this.parentTemplateId, templatedPAComponentSummary.parentTemplateId) && + Objects.equals(this.type, templatedPAComponentSummary.type); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java new file mode 100644 index 00000000..b6000732 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentSummaryRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentSummaryRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public TemplatedPAComponentSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public TemplatedPAComponentSummaryRoot putDataItem(String key, TemplatedPAComponentSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public TemplatedPAComponentSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this TemplatedPAComponentSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentSummaryRoot templatedPAComponentSummaryRoot = (TemplatedPAComponentSummaryRoot) o; + return Objects.equals(this.data, templatedPAComponentSummaryRoot.data) && + Objects.equals(this.meta, templatedPAComponentSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java new file mode 100644 index 00000000..8f21bcb0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java @@ -0,0 +1,172 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentUpdateParameters + */ +@JsonPropertyOrder({ + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_COMPONENT_DATA +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + + public TemplatedPAComponentUpdateParameters parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Parent template id + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Parent template id") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Component description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentUpdateParameters componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + /** + * Return true if this TemplatedPAComponentUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentUpdateParameters templatedPAComponentUpdateParameters = (TemplatedPAComponentUpdateParameters) o; + return Objects.equals(this.parentTemplateId, templatedPAComponentUpdateParameters.parentTemplateId) && + Objects.equals(this.description, templatedPAComponentUpdateParameters.description) && + Objects.equals(this.componentData, templatedPAComponentUpdateParameters.componentData); + } + + @Override + public int hashCode() { + return Objects.hash(parentTemplateId, description, componentData); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentUpdateParameters {\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java new file mode 100644 index 00000000..791fadb0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentUpdateParametersRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public TemplatedPAComponentUpdateParametersRoot data(TemplatedPAComponentUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentUpdateParameters getData() { + return data; + } + + + public void setData(TemplatedPAComponentUpdateParameters data) { + this.data = data; + } + + + public TemplatedPAComponentUpdateParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this TemplatedPAComponentUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot = (TemplatedPAComponentUpdateParametersRoot) o; + return Objects.equals(this.data, templatedPAComponentUpdateParametersRoot.data) && + Objects.equals(this.meta, templatedPAComponentUpdateParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java new file mode 100644 index 00000000..5c840c05 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java @@ -0,0 +1,599 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationDataSources; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplate + */ +@JsonPropertyOrder({ + UnlinkedPATemplate.JSON_PROPERTY_ID, + UnlinkedPATemplate.JSON_PROPERTY_DIRECTORY, + UnlinkedPATemplate.JSON_PROPERTY_TEMPLATE_TYPE_ID, + UnlinkedPATemplate.JSON_PROPERTY_SNAPSHOT, + UnlinkedPATemplate.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplate.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplate.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplate.JSON_PROPERTY_DATES, + UnlinkedPATemplate.JSON_PROPERTY_GROUPS, + UnlinkedPATemplate.JSON_PROPERTY_DATASOURCES, + UnlinkedPATemplate.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplate.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplate.JSON_PROPERTY_CONTENT, + UnlinkedPATemplate.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplate.JSON_PROPERTY_NAME, + UnlinkedPATemplate.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplate implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; + private String templateTypeId; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_DATASOURCES = "datasources"; + private PACalculationDataSources datasources; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public UnlinkedPATemplate id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplate directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Template directory. + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template directory.") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public UnlinkedPATemplate templateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + return this; + } + + /** + * Template type id + * @return templateTypeId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template type id") + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTemplateTypeId() { + return templateTypeId; + } + + + public void setTemplateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + } + + + public UnlinkedPATemplate snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * snapshot. + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "snapshot.") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public UnlinkedPATemplate accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplate addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplate benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplate addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplate columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplate addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplate dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplate groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplate addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplate datasources(PACalculationDataSources datasources) { + this.datasources = datasources; + return this; + } + + /** + * Get datasources + * @return datasources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATASOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACalculationDataSources getDatasources() { + return datasources; + } + + + public void setDatasources(PACalculationDataSources datasources) { + this.datasources = datasources; + } + + + public UnlinkedPATemplate currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplate componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplate content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + public UnlinkedPATemplate description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplate name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplate category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplate unlinkedPATemplate = (UnlinkedPATemplate) o; + return Objects.equals(this.id, unlinkedPATemplate.id) && + Objects.equals(this.directory, unlinkedPATemplate.directory) && + Objects.equals(this.templateTypeId, unlinkedPATemplate.templateTypeId) && + Objects.equals(this.snapshot, unlinkedPATemplate.snapshot) && + Objects.equals(this.accounts, unlinkedPATemplate.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplate.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplate.columns) && + Objects.equals(this.dates, unlinkedPATemplate.dates) && + Objects.equals(this.groups, unlinkedPATemplate.groups) && + Objects.equals(this.datasources, unlinkedPATemplate.datasources) && + Objects.equals(this.currencyisocode, unlinkedPATemplate.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplate.componentdetail) && + Objects.equals(this.content, unlinkedPATemplate.content) && + Objects.equals(this.description, unlinkedPATemplate.description) && + Objects.equals(this.name, unlinkedPATemplate.name) && + Objects.equals(this.category, unlinkedPATemplate.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, directory, templateTypeId, snapshot, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content, description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplate {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java new file mode 100644 index 00000000..25f4268d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndType + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_CATEGORY, + UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndType implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + + public UnlinkedPATemplateCategoryAndType category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + public UnlinkedPATemplateCategoryAndType name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template type + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template type") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndType object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndType unlinkedPATemplateCategoryAndType = (UnlinkedPATemplateCategoryAndType) o; + return Objects.equals(this.category, unlinkedPATemplateCategoryAndType.category) && + Objects.equals(this.name, unlinkedPATemplateCategoryAndType.name); + } + + @Override + public int hashCode() { + return Objects.hash(category, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndType {\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java new file mode 100644 index 00000000..0145c0bc --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java @@ -0,0 +1,279 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateColumnDetails; +import factset.analyticsapi.engines.models.UnlinkedPATemplateGroupDetails; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_ID, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_SNAPSHOT, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_CATEGORY, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + + public UnlinkedPATemplateCategoryAndTypeDetails id(String id) { + this.id = id; + return this; + } + + /** + * Type Id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Type Id") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeDetails addColumnsItem(UnlinkedPATemplateColumnDetails columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of default columns + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of default columns") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeDetails addGroupsItem(UnlinkedPATemplateGroupDetails groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of default groupings + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of default groupings") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * Snapshot + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Snapshot") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template type + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template type") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeDetails unlinkedPATemplateCategoryAndTypeDetails = (UnlinkedPATemplateCategoryAndTypeDetails) o; + return Objects.equals(this.id, unlinkedPATemplateCategoryAndTypeDetails.id) && + Objects.equals(this.columns, unlinkedPATemplateCategoryAndTypeDetails.columns) && + Objects.equals(this.groups, unlinkedPATemplateCategoryAndTypeDetails.groups) && + Objects.equals(this.snapshot, unlinkedPATemplateCategoryAndTypeDetails.snapshot) && + Objects.equals(this.category, unlinkedPATemplateCategoryAndTypeDetails.category) && + Objects.equals(this.name, unlinkedPATemplateCategoryAndTypeDetails.name); + } + + @Override + public int hashCode() { + return Objects.hash(id, columns, groups, snapshot, category, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeDetails {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java new file mode 100644 index 00000000..70e4a3b3 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetails; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeDetailsRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeDetailsRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateCategoryAndTypeDetails data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateCategoryAndTypeDetailsRoot data(UnlinkedPATemplateCategoryAndTypeDetails data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateCategoryAndTypeDetails getData() { + return data; + } + + + public void setData(UnlinkedPATemplateCategoryAndTypeDetails data) { + this.data = data; + } + + + public UnlinkedPATemplateCategoryAndTypeDetailsRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeDetailsRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeDetailsRoot unlinkedPATemplateCategoryAndTypeDetailsRoot = (UnlinkedPATemplateCategoryAndTypeDetailsRoot) o; + return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeDetailsRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateCategoryAndTypeDetailsRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeDetailsRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java new file mode 100644 index 00000000..48326bce --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndType; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateCategoryAndTypeRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeRoot putDataItem(String key, UnlinkedPATemplateCategoryAndType dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public UnlinkedPATemplateCategoryAndTypeRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeRoot unlinkedPATemplateCategoryAndTypeRoot = (UnlinkedPATemplateCategoryAndTypeRoot) o; + return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateCategoryAndTypeRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java new file mode 100644 index 00000000..f3dab968 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java @@ -0,0 +1,179 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateColumnDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_NAME, + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_ID, + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_STATISTICS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateColumnDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_STATISTICS = "statistics"; + private java.util.List statistics = null; + + + public UnlinkedPATemplateColumnDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template column name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template column name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateColumnDetails id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Column identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Column identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplateColumnDetails statistics(java.util.List statistics) { + this.statistics = statistics; + return this; + } + + public UnlinkedPATemplateColumnDetails addStatisticsItem(String statisticsItem) { + if (this.statistics == null) { + this.statistics = new java.util.ArrayList(); + } + this.statistics.add(statisticsItem); + return this; + } + + /** + * Column Statistic identifier + * @return statistics + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Statistic identifier") + @JsonProperty(JSON_PROPERTY_STATISTICS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getStatistics() { + return statistics; + } + + + public void setStatistics(java.util.List statistics) { + this.statistics = statistics; + } + + + /** + * Return true if this UnlinkedPATemplateColumnDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateColumnDetails unlinkedPATemplateColumnDetails = (UnlinkedPATemplateColumnDetails) o; + return Objects.equals(this.name, unlinkedPATemplateColumnDetails.name) && + Objects.equals(this.id, unlinkedPATemplateColumnDetails.id) && + Objects.equals(this.statistics, unlinkedPATemplateColumnDetails.statistics); + } + + @Override + public int hashCode() { + return Objects.hash(name, id, statistics); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateColumnDetails {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" statistics: ").append(toIndentedString(statistics)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java new file mode 100644 index 00000000..1366a2c5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateGroupDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateGroupDetails.JSON_PROPERTY_NAME, + UnlinkedPATemplateGroupDetails.JSON_PROPERTY_ID, + UnlinkedPATemplateGroupDetails.JSON_PROPERTY_FREQUENCY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateGroupDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + + public UnlinkedPATemplateGroupDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template group name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template group name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateGroupDetails id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Group identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Group identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplateGroupDetails frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Grouping frequency + * @return frequency + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Grouping frequency") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + /** + * Return true if this UnlinkedPATemplateGroupDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateGroupDetails unlinkedPATemplateGroupDetails = (UnlinkedPATemplateGroupDetails) o; + return Objects.equals(this.name, unlinkedPATemplateGroupDetails.name) && + Objects.equals(this.id, unlinkedPATemplateGroupDetails.id) && + Objects.equals(this.frequency, unlinkedPATemplateGroupDetails.frequency); + } + + @Override + public int hashCode() { + return Objects.hash(name, id, frequency); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateGroupDetails {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java new file mode 100644 index 00000000..94277a1e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java @@ -0,0 +1,477 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationDataSources; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateParameters + */ +@JsonPropertyOrder({ + UnlinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, + UnlinkedPATemplateParameters.JSON_PROPERTY_TEMPLATE_TYPE_ID, + UnlinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateParameters.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplateParameters.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplateParameters.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateParameters.JSON_PROPERTY_DATES, + UnlinkedPATemplateParameters.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateParameters.JSON_PROPERTY_DATASOURCES, + UnlinkedPATemplateParameters.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplateParameters.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; + private String templateTypeId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_DATASOURCES = "datasources"; + private PACalculationDataSources datasources; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + + public UnlinkedPATemplateParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * The directory to create an unlinked PA template + * @return directory + **/ + @ApiModelProperty(required = true, value = "The directory to create an unlinked PA template") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + public void setDirectory(String directory) { + this.directory = directory; + } + + + public UnlinkedPATemplateParameters templateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + return this; + } + + /** + * Template type id + * @return templateTypeId + **/ + @ApiModelProperty(required = true, value = "Template type id") + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getTemplateTypeId() { + return templateTypeId; + } + + + public void setTemplateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + } + + + public UnlinkedPATemplateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateParameters accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplateParameters addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplateParameters benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplateParameters columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateParameters addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateParameters dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplateParameters groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateParameters addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateParameters datasources(PACalculationDataSources datasources) { + this.datasources = datasources; + return this; + } + + /** + * Get datasources + * @return datasources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATASOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACalculationDataSources getDatasources() { + return datasources; + } + + + public void setDatasources(PACalculationDataSources datasources) { + this.datasources = datasources; + } + + + public UnlinkedPATemplateParameters currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplateParameters componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this UnlinkedPATemplateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateParameters unlinkedPATemplateParameters = (UnlinkedPATemplateParameters) o; + return Objects.equals(this.directory, unlinkedPATemplateParameters.directory) && + Objects.equals(this.templateTypeId, unlinkedPATemplateParameters.templateTypeId) && + Objects.equals(this.description, unlinkedPATemplateParameters.description) && + Objects.equals(this.accounts, unlinkedPATemplateParameters.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplateParameters.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplateParameters.columns) && + Objects.equals(this.dates, unlinkedPATemplateParameters.dates) && + Objects.equals(this.groups, unlinkedPATemplateParameters.groups) && + Objects.equals(this.datasources, unlinkedPATemplateParameters.datasources) && + Objects.equals(this.currencyisocode, unlinkedPATemplateParameters.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplateParameters.componentdetail) && + Objects.equals(this.content, unlinkedPATemplateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(directory, templateTypeId, description, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java new file mode 100644 index 00000000..6a51f9eb --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateParametersRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateParametersRoot data(UnlinkedPATemplateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateParameters getData() { + return data; + } + + + public void setData(UnlinkedPATemplateParameters data) { + this.data = data; + } + + + public UnlinkedPATemplateParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = (UnlinkedPATemplateParametersRoot) o; + return Objects.equals(this.data, unlinkedPATemplateParametersRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java new file mode 100644 index 00000000..80e1a7f0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java @@ -0,0 +1,201 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplatePostSummary + */ +@JsonPropertyOrder({ + UnlinkedPATemplatePostSummary.JSON_PROPERTY_ID, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_NAME, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplatePostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public UnlinkedPATemplatePostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplatePostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplatePostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplatePostSummary category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplatePostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplatePostSummary unlinkedPATemplatePostSummary = (UnlinkedPATemplatePostSummary) o; + return Objects.equals(this.id, unlinkedPATemplatePostSummary.id) && + Objects.equals(this.description, unlinkedPATemplatePostSummary.description) && + Objects.equals(this.name, unlinkedPATemplatePostSummary.name) && + Objects.equals(this.category, unlinkedPATemplatePostSummary.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplatePostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java new file mode 100644 index 00000000..5d8dda34 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplatePostSummaryRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplatePostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplatePostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplatePostSummaryRoot data(UnlinkedPATemplatePostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplatePostSummary getData() { + return data; + } + + + public void setData(UnlinkedPATemplatePostSummary data) { + this.data = data; + } + + + public UnlinkedPATemplatePostSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplatePostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplatePostSummaryRoot unlinkedPATemplatePostSummaryRoot = (UnlinkedPATemplatePostSummaryRoot) o; + return Objects.equals(this.data, unlinkedPATemplatePostSummaryRoot.data) && + Objects.equals(this.meta, unlinkedPATemplatePostSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplatePostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java new file mode 100644 index 00000000..642eac87 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplate data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateRoot data(UnlinkedPATemplate data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplate getData() { + return data; + } + + + public void setData(UnlinkedPATemplate data) { + this.data = data; + } + + + public UnlinkedPATemplateRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateRoot unlinkedPATemplateRoot = (UnlinkedPATemplateRoot) o; + return Objects.equals(this.data, unlinkedPATemplateRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java new file mode 100644 index 00000000..22f4edd6 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java @@ -0,0 +1,171 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateSummary + */ +@JsonPropertyOrder({ + UnlinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateSummary.JSON_PROPERTY_NAME, + UnlinkedPATemplateSummary.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + + public UnlinkedPATemplateSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateSummary category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplateSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateSummary unlinkedPATemplateSummary = (UnlinkedPATemplateSummary) o; + return Objects.equals(this.description, unlinkedPATemplateSummary.description) && + Objects.equals(this.name, unlinkedPATemplateSummary.name) && + Objects.equals(this.category, unlinkedPATemplateSummary.category); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java new file mode 100644 index 00000000..2eacaf4f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java @@ -0,0 +1,146 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateSummaryRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public UnlinkedPATemplateSummaryRoot putDataItem(String key, UnlinkedPATemplateSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + public void setData(java.util.Map data) { + this.data = data; + } + + + public UnlinkedPATemplateSummaryRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateSummaryRoot unlinkedPATemplateSummaryRoot = (UnlinkedPATemplateSummaryRoot) o; + return Objects.equals(this.data, unlinkedPATemplateSummaryRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateSummaryRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java new file mode 100644 index 00000000..98365ef4 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java @@ -0,0 +1,419 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationDataSources; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateUpdateParameters + */ +@JsonPropertyOrder({ + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DATES, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DATASOURCES, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_DATASOURCES = "datasources"; + private PACalculationDataSources datasources; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + + public UnlinkedPATemplateUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateUpdateParameters accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplateUpdateParameters addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplateUpdateParameters benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplateUpdateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplateUpdateParameters columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateUpdateParameters addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateUpdateParameters dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplateUpdateParameters groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateUpdateParameters addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateUpdateParameters datasources(PACalculationDataSources datasources) { + this.datasources = datasources; + return this; + } + + /** + * Get datasources + * @return datasources + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATASOURCES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PACalculationDataSources getDatasources() { + return datasources; + } + + + public void setDatasources(PACalculationDataSources datasources) { + this.datasources = datasources; + } + + + public UnlinkedPATemplateUpdateParameters currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplateUpdateParameters componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplateUpdateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this UnlinkedPATemplateUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateUpdateParameters unlinkedPATemplateUpdateParameters = (UnlinkedPATemplateUpdateParameters) o; + return Objects.equals(this.description, unlinkedPATemplateUpdateParameters.description) && + Objects.equals(this.accounts, unlinkedPATemplateUpdateParameters.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplateUpdateParameters.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplateUpdateParameters.columns) && + Objects.equals(this.dates, unlinkedPATemplateUpdateParameters.dates) && + Objects.equals(this.groups, unlinkedPATemplateUpdateParameters.groups) && + Objects.equals(this.datasources, unlinkedPATemplateUpdateParameters.datasources) && + Objects.equals(this.currencyisocode, unlinkedPATemplateUpdateParameters.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplateUpdateParameters.componentdetail) && + Objects.equals(this.content, unlinkedPATemplateUpdateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(description, accounts, benchmarks, columns, dates, groups, datasources, currencyisocode, componentdetail, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateUpdateParameters {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" datasources: ").append(toIndentedString(datasources)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java new file mode 100644 index 00000000..f761c68d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java @@ -0,0 +1,141 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateUpdateParametersRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private Object meta; + + + public UnlinkedPATemplateUpdateParametersRoot data(UnlinkedPATemplateUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateUpdateParameters getData() { + return data; + } + + + public void setData(UnlinkedPATemplateUpdateParameters data) { + this.data = data; + } + + + public UnlinkedPATemplateUpdateParametersRoot meta(Object meta) { + this.meta = meta; + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Object getMeta() { + return meta; + } + + + public void setMeta(Object meta) { + this.meta = meta; + } + + + /** + * Return true if this UnlinkedPATemplateUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot = (UnlinkedPATemplateUpdateParametersRoot) o; + return Objects.equals(this.data, unlinkedPATemplateUpdateParametersRoot.data) && + Objects.equals(this.meta, unlinkedPATemplateUpdateParametersRoot.meta); + } + + @Override + public int hashCode() { + return Objects.hash(data, meta); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + From 56f5b6ae4ba875adbc5aee7a3eeef02778b44593 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 06:44:07 +0000 Subject: [PATCH 03/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- auto-generated-sdk/README.md | 6 +++--- auto-generated-sdk/build.gradle | 2 +- auto-generated-sdk/build.sbt | 2 +- auto-generated-sdk/pom.xml | 2 +- .../main/java/factset/analyticsapi/engines/ApiClient.java | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index d8b9256c..57765f55 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -42,7 +42,7 @@ Add this dependency to your project's POM: com.factset.analyticsapi engines-sdk - 6.3.0-rc.1 + 6.3.0 compile ``` @@ -52,7 +52,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "com.factset.analyticsapi:engines-sdk:6.3.0-rc.1" +compile "com.factset.analyticsapi:engines-sdk:6.3.0" ``` ### Others @@ -65,7 +65,7 @@ mvn clean package Then manually install the following JARs: -- `target/engines-sdk-6.3.0-rc.1.jar` +- `target/engines-sdk-6.3.0.jar` - `target/lib/*.jar` ## Usage diff --git a/auto-generated-sdk/build.gradle b/auto-generated-sdk/build.gradle index 97f6352e..6c695766 100644 --- a/auto-generated-sdk/build.gradle +++ b/auto-generated-sdk/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'idea' apply plugin: 'eclipse' group = 'com.factset.analyticsapi' -version = '6.3.0-rc.1' +version = '6.3.0' buildscript { repositories { diff --git a/auto-generated-sdk/build.sbt b/auto-generated-sdk/build.sbt index 17a24e93..153278c5 100644 --- a/auto-generated-sdk/build.sbt +++ b/auto-generated-sdk/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.factset.analyticsapi", name := "engines-sdk", - version := "6.3.0-rc.1", + version := "6.3.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index a4f9ba4d..d0c0b218 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -5,7 +5,7 @@ engines-sdk jar engines-sdk - 6.3.0-rc.1 + 6.3.0 https://github.com/factset/analyticsapi-engines-java-sdk DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java index 06b44189..1119b05c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java @@ -118,7 +118,7 @@ public ApiClient(Map authMap) { httpClient = buildHttpClient(); this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("engines-api/6.3.0-rc.1/java"); + setUserAgent("engines-api/6.3.0/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap(); Authentication auth = null; From 548526fd97c63f48c01fa1a5024cce0a9dcd5ee7 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 09:57:12 +0000 Subject: [PATCH 04/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- auto-generated-sdk/.openapi-generator/FILES | 50 +- auto-generated-sdk/README.md | 29 +- auto-generated-sdk/api/openapi.yaml | 5429 ++++++----------- auto-generated-sdk/docs/AccountDirectories.md | 1 - auto-generated-sdk/docs/CalculationStatus.md | 1 - .../docs/CalculationStatusMeta.md | 3 +- .../docs/CalculationUnitStatus.md | 1 - .../docs/CalculationUnitStatusMeta.md | 1 - auto-generated-sdk/docs/ComponentsApi.md | 4 +- auto-generated-sdk/docs/ConfigurationsApi.md | 87 +- auto-generated-sdk/docs/Currency.md | 1 - .../docs/FIConvertibleSettings.md | 32 - auto-generated-sdk/docs/FISecurity.md | 1 - auto-generated-sdk/docs/FiCalculationsApi.md | 2 +- .../docs/LinkedPaTemplatesApi.md | 2 +- auto-generated-sdk/docs/Metadata.md | 22 - auto-generated-sdk/docs/PACommentary.md | 19 - .../docs/PACommentaryConfigurationSummary.md | 18 - .../PACommentaryConfigurationSummaryRoot.md | 18 - auto-generated-sdk/docs/PACommentaryDate.md | 18 - .../docs/PACommentaryGetStatus.md | 28 - .../docs/PACommentaryGetStatusRoot.md | 18 - .../docs/PACommentaryParametersRoot.md | 18 - auto-generated-sdk/docs/PACommentaryRoot.md | 18 - auto-generated-sdk/docs/PACommentaryStatus.md | 29 - auto-generated-sdk/docs/PaCalculationsApi.md | 277 +- auto-generated-sdk/docs/PubCalculationsApi.md | 24 +- .../docs/QuantCalculationsApi.md | 2 +- .../docs/QuantDateListObsolete.md | 20 + .../docs/QuantFdsDateObsolete.md | 21 + .../docs/QuantFqlExpressionObsolete.md | 20 + .../docs/QuantIdentifierUniverseObsolete.md | 38 + ...md => QuantScreeningExpressionObsolete.md} | 7 +- ...uantScreeningExpressionUniverseObsolete.md | 39 + ... QuantUniversalScreenParameterObsolete.md} | 5 +- .../QuantUniversalScreenUniverseObsolete.md | 28 + auto-generated-sdk/docs/SPARDateParameters.md | 1 - auto-generated-sdk/docs/Section.md | 20 - .../docs/SparCalculationsApi.md | 2 +- .../docs/TemplatedPaComponentsApi.md | 4 +- .../docs/VaultAttributionLoaderApi.md | 95 - .../docs/VaultAttributionLoaderResponse.md | 19 - .../VaultAttributionLoaderResponseRoot.md | 18 - .../docs/VaultCalculationsApi.md | 2 +- .../engines/api/ConfigurationsApi.java | 87 - .../engines/api/FiCalculationsApi.java | 2 +- .../engines/api/LinkedPaTemplatesApi.java | 2 +- .../engines/api/PaCalculationsApi.java | 288 +- .../engines/api/PubCalculationsApi.java | 44 +- .../engines/api/QuantCalculationsApi.java | 2 +- .../engines/api/SparCalculationsApi.java | 2 +- .../engines/api/TemplatedPaComponentsApi.java | 4 +- .../api/VaultAttributionLoaderApi.java | 140 - .../engines/api/VaultCalculationsApi.java | 2 +- .../engines/models/AccountDirectories.java | 3 +- .../engines/models/CalculationStatus.java | 3 +- .../engines/models/CalculationStatusMeta.java | 7 +- .../engines/models/CalculationUnitStatus.java | 3 +- .../models/CalculationUnitStatusMeta.java | 3 +- .../analyticsapi/engines/models/Currency.java | 3 +- .../engines/models/FIConvertibleSettings.java | 298 - .../engines/models/FISecurity.java | 33 +- .../analyticsapi/engines/models/Metadata.java | 262 - .../engines/models/PACommentary.java | 180 - .../PACommentaryConfigurationSummaryRoot.java | 146 - .../engines/models/PACommentaryDate.java | 141 - .../engines/models/PACommentaryGetStatus.java | 206 - .../models/PACommentaryGetStatusRoot.java | 141 - .../models/PACommentaryParameters.java | 111 - .../models/PACommentaryParametersRoot.java | 141 - .../engines/models/PACommentaryRoot.java | 141 - .../engines/models/PACommentaryStatus.java | 236 - .../models/PACommentaryStatusRoot.java | 141 - .../engines/models/QuantDateListObsolete.java | 207 + .../engines/models/QuantFdsDateObsolete.java | 227 + .../models/QuantFqlExpressionObsolete.java | 199 + .../QuantIdentifierUniverseObsolete.java | 246 + .../QuantScreeningExpressionObsolete.java | 169 + ...ntScreeningExpressionUniverseObsolete.java | 271 + ...uantUniversalScreenParameterObsolete.java} | 74 +- .../QuantUniversalScreenUniverseObsolete.java | 177 + .../engines/models/SPARDateParameters.java | 36 +- .../analyticsapi/engines/models/Section.java | 210 - .../VaultAttributionLoaderResponse.java | 171 - .../VaultAttributionLoaderResponseRoot.java | 141 - 85 files changed, 3716 insertions(+), 7676 deletions(-) delete mode 100644 auto-generated-sdk/docs/FIConvertibleSettings.md delete mode 100644 auto-generated-sdk/docs/Metadata.md delete mode 100644 auto-generated-sdk/docs/PACommentary.md delete mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummary.md delete mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/PACommentaryDate.md delete mode 100644 auto-generated-sdk/docs/PACommentaryGetStatus.md delete mode 100644 auto-generated-sdk/docs/PACommentaryGetStatusRoot.md delete mode 100644 auto-generated-sdk/docs/PACommentaryParametersRoot.md delete mode 100644 auto-generated-sdk/docs/PACommentaryRoot.md delete mode 100644 auto-generated-sdk/docs/PACommentaryStatus.md create mode 100644 auto-generated-sdk/docs/QuantDateListObsolete.md create mode 100644 auto-generated-sdk/docs/QuantFdsDateObsolete.md create mode 100644 auto-generated-sdk/docs/QuantFqlExpressionObsolete.md create mode 100644 auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md rename auto-generated-sdk/docs/{PACommentaryStatusRoot.md => QuantScreeningExpressionObsolete.md} (54%) create mode 100644 auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md rename auto-generated-sdk/docs/{PACommentaryParameters.md => QuantUniversalScreenParameterObsolete.md} (60%) create mode 100644 auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/Section.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderApi.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderResponse.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java rename auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/{PACommentaryConfigurationSummary.java => QuantUniversalScreenParameterObsolete.java} (58%) create mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java delete mode 100644 auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index f3a29001..5d30cbea 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -76,7 +76,6 @@ docs/FIBankLoans.md docs/FICalculationParameters.md docs/FICalculationParametersRoot.md docs/FICashflows.md -docs/FIConvertibleSettings.md docs/FIDiscountCurveInfo.md docs/FIDiscountCurveInfoRoot.md docs/FIJobSettings.md @@ -119,7 +118,6 @@ docs/LinkedPATemplateSummaryRoot.md docs/LinkedPATemplateUpdateParameters.md docs/LinkedPATemplateUpdateParametersRoot.md docs/LinkedPaTemplatesApi.md -docs/Metadata.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerStrategy.md @@ -142,17 +140,6 @@ docs/PACalculationGroup.md docs/PACalculationParameters.md docs/PACalculationParametersRoot.md docs/PACalculationPricingSource.md -docs/PACommentary.md -docs/PACommentaryConfigurationSummary.md -docs/PACommentaryConfigurationSummaryRoot.md -docs/PACommentaryDate.md -docs/PACommentaryGetStatus.md -docs/PACommentaryGetStatusRoot.md -docs/PACommentaryParameters.md -docs/PACommentaryParametersRoot.md -docs/PACommentaryRoot.md -docs/PACommentaryStatus.md -docs/PACommentaryStatusRoot.md docs/PAComponent.md docs/PAComponentData.md docs/PAComponentRoot.md @@ -177,14 +164,22 @@ docs/QuantCalculationParametersRoot.md docs/QuantCalculationsApi.md docs/QuantDate.md docs/QuantDateList.md +docs/QuantDateListObsolete.md docs/QuantFdsDate.md +docs/QuantFdsDateObsolete.md docs/QuantFormula.md docs/QuantFqlExpression.md +docs/QuantFqlExpressionObsolete.md docs/QuantIdentifierUniverse.md +docs/QuantIdentifierUniverseObsolete.md docs/QuantScreeningExpression.md +docs/QuantScreeningExpressionObsolete.md docs/QuantScreeningExpressionUniverse.md +docs/QuantScreeningExpressionUniverseObsolete.md docs/QuantUniversalScreenParameter.md +docs/QuantUniversalScreenParameterObsolete.md docs/QuantUniversalScreenUniverse.md +docs/QuantUniversalScreenUniverseObsolete.md docs/QuantUniverse.md docs/ReturnType.md docs/SPARAccounts.md @@ -197,7 +192,6 @@ docs/SPARComponent.md docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md -docs/Section.md docs/SparCalculationsApi.md docs/StrategyDocumentsApi.md docs/TemplateContentTypes.md @@ -229,9 +223,6 @@ 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 @@ -292,7 +283,6 @@ src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.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 @@ -357,7 +347,6 @@ src/main/java/factset/analyticsapi/engines/models/FIBankLoans.java src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/FICashflows.java -src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java src/main/java/factset/analyticsapi/engines/models/FIDiscountCurveInfo.java src/main/java/factset/analyticsapi/engines/models/FIDiscountCurveInfoRoot.java src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java @@ -394,7 +383,6 @@ src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/Metadata.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java @@ -416,17 +404,6 @@ src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/PACalculationPricingSource.java -src/main/java/factset/analyticsapi/engines/models/PACommentary.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java -src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java src/main/java/factset/analyticsapi/engines/models/PAComponent.java src/main/java/factset/analyticsapi/engines/models/PAComponentData.java src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java @@ -447,14 +424,22 @@ src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.jav src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/QuantDate.java src/main/java/factset/analyticsapi/engines/models/QuantDateList.java +src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java +src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantFormula.java src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java +src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java +src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java +src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java +src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java +src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java 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 @@ -467,7 +452,6 @@ src/main/java/factset/analyticsapi/engines/models/SPARComponent.java src/main/java/factset/analyticsapi/engines/models/SPARComponentRoot.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/Section.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 @@ -495,8 +479,6 @@ 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 57765f55..47b616fe 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -171,7 +171,6 @@ Class | Method | HTTP request | Description *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* | [**getPACommentaryConfigurations**](docs/ConfigurationsApi.md#getPACommentaryConfigurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory *ConfigurationsApi* | [**getVaultConfigurationById**](docs/ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**getVaultConfigurations**](docs/ConfigurationsApi.md#getVaultConfigurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**getCurrencies**](docs/CurrenciesApi.md#getCurrencies) | **GET** /analytics/lookups/v3/currencies | Get currencies @@ -214,13 +213,10 @@ Class | Method | HTTP request | Description *NpoOptimizerApi* | [**postAndOptimize**](docs/NpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NpoOptimizerApi* | [**putAndOptimize**](docs/NpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. *PaCalculationsApi* | [**cancelCalculationById**](docs/PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -*PaCalculationsApi* | [**generatePAPortfolioCommentary**](docs/PaCalculationsApi.md#generatePAPortfolioCommentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. *PaCalculationsApi* | [**getAllCalculations**](docs/PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations *PaCalculationsApi* | [**getCalculationParameters**](docs/PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id *PaCalculationsApi* | [**getCalculationStatusById**](docs/PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id *PaCalculationsApi* | [**getCalculationUnitResultById**](docs/PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -*PaCalculationsApi* | [**getPAPortfolioCommentaryResultById**](docs/PaCalculationsApi.md#getPAPortfolioCommentaryResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. -*PaCalculationsApi* | [**getPAPortfolioCommentaryStatusById**](docs/PaCalculationsApi.md#getPAPortfolioCommentaryStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. *PaCalculationsApi* | [**postAndCalculate**](docs/PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation *PaCalculationsApi* | [**putAndCalculate**](docs/PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. *PricingSourcesApi* | [**getPAPricingSources**](docs/PricingSourcesApi.md#getPAPricingSources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources @@ -263,7 +259,6 @@ 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 @@ -333,7 +328,6 @@ Class | Method | HTTP request | Description - [FICalculationParameters](docs/FICalculationParameters.md) - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md) - [FICashflows](docs/FICashflows.md) - - [FIConvertibleSettings](docs/FIConvertibleSettings.md) - [FIDiscountCurveInfo](docs/FIDiscountCurveInfo.md) - [FIDiscountCurveInfoRoot](docs/FIDiscountCurveInfoRoot.md) - [FIJobSettings](docs/FIJobSettings.md) @@ -370,7 +364,6 @@ Class | Method | HTTP request | Description - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) - - [Metadata](docs/Metadata.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -392,17 +385,6 @@ Class | Method | HTTP request | Description - [PACalculationParameters](docs/PACalculationParameters.md) - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) - [PACalculationPricingSource](docs/PACalculationPricingSource.md) - - [PACommentary](docs/PACommentary.md) - - [PACommentaryConfigurationSummary](docs/PACommentaryConfigurationSummary.md) - - [PACommentaryConfigurationSummaryRoot](docs/PACommentaryConfigurationSummaryRoot.md) - - [PACommentaryDate](docs/PACommentaryDate.md) - - [PACommentaryGetStatus](docs/PACommentaryGetStatus.md) - - [PACommentaryGetStatusRoot](docs/PACommentaryGetStatusRoot.md) - - [PACommentaryParameters](docs/PACommentaryParameters.md) - - [PACommentaryParametersRoot](docs/PACommentaryParametersRoot.md) - - [PACommentaryRoot](docs/PACommentaryRoot.md) - - [PACommentaryStatus](docs/PACommentaryStatus.md) - - [PACommentaryStatusRoot](docs/PACommentaryStatusRoot.md) - [PAComponent](docs/PAComponent.md) - [PAComponentData](docs/PAComponentData.md) - [PAComponentRoot](docs/PAComponentRoot.md) @@ -423,14 +405,22 @@ Class | Method | HTTP request | Description - [QuantCalculationParametersRoot](docs/QuantCalculationParametersRoot.md) - [QuantDate](docs/QuantDate.md) - [QuantDateList](docs/QuantDateList.md) + - [QuantDateListObsolete](docs/QuantDateListObsolete.md) - [QuantFdsDate](docs/QuantFdsDate.md) + - [QuantFdsDateObsolete](docs/QuantFdsDateObsolete.md) - [QuantFormula](docs/QuantFormula.md) - [QuantFqlExpression](docs/QuantFqlExpression.md) + - [QuantFqlExpressionObsolete](docs/QuantFqlExpressionObsolete.md) - [QuantIdentifierUniverse](docs/QuantIdentifierUniverse.md) + - [QuantIdentifierUniverseObsolete](docs/QuantIdentifierUniverseObsolete.md) - [QuantScreeningExpression](docs/QuantScreeningExpression.md) + - [QuantScreeningExpressionObsolete](docs/QuantScreeningExpressionObsolete.md) - [QuantScreeningExpressionUniverse](docs/QuantScreeningExpressionUniverse.md) + - [QuantScreeningExpressionUniverseObsolete](docs/QuantScreeningExpressionUniverseObsolete.md) - [QuantUniversalScreenParameter](docs/QuantUniversalScreenParameter.md) + - [QuantUniversalScreenParameterObsolete](docs/QuantUniversalScreenParameterObsolete.md) - [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md) + - [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md) - [QuantUniverse](docs/QuantUniverse.md) - [ReturnType](docs/ReturnType.md) - [SPARAccounts](docs/SPARAccounts.md) @@ -443,7 +433,6 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) - - [Section](docs/Section.md) - [TemplateContentTypes](docs/TemplateContentTypes.md) - [TemplatedPAComponent](docs/TemplatedPAComponent.md) - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) @@ -471,8 +460,6 @@ 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 c08a1891..40fee24c 100644 --- a/auto-generated-sdk/api/openapi.yaml +++ b/auto-generated-sdk/api/openapi.yaml @@ -8753,7 +8753,6 @@ paths: required: true schema: description: Document Name - example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT type: string style: form responses: @@ -9060,7 +9059,6 @@ paths: required: true schema: description: Unique identifier for a vault component - example: AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D type: string style: simple responses: @@ -9370,7 +9368,6 @@ paths: schema: description: Required account query parameter to filter configurations for a specific account - example: CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT type: string style: form responses: @@ -9664,30 +9661,28 @@ paths: - status-code: "200" response-type: VaultConfigurationSummaryRoot x-accepts: application/json - /analytics/engines/pa/v3/commentary/configurations: + /analytics/engines/vault/v3/configurations/{id}: get: - description: This endpoint returns all PA commentary configurations in a given - directory. - operationId: getPACommentaryConfigurations + description: This endpoint returns details for a Vault configuration as well + as a list of accounts it is used in. + operationId: getVaultConfigurationById parameters: - - description: The directory to get the PA commentary configurations - explode: true - in: query - name: path + - description: Vault configuration id to get the details of + explode: false + in: path + name: id required: true schema: - description: The directory to get the PA commentary configurations - example: 'Client:' + description: Vault configuration id to get the details of type: string - style: form + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PACommentaryConfigurationSummaryRoot' - description: Expected response, returns a map of configuration ID to PA - commentary configuration + $ref: '#/components/schemas/VaultConfigurationRoot' + description: Expected response, returns details for a Vault configuration. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9728,7 +9723,48 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid path provided + description: Invalid vault configuration code. + 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: Vault configuration id not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9765,7 +9801,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. @@ -9821,7 +9857,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. @@ -9886,7 +9922,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. @@ -9905,7 +9941,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. @@ -9923,119 +9959,26 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA commentary configurations in a directory + summary: Get Vault configuration by id tags: - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: PACommentaryConfigurationSummaryRoot + 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 - example: e95ef921-b4d4-4bb7-93ba-60eca8e3247a - 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. - 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 vault configuration code. - 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: Vault configuration id not found. + $ref: '#/components/schemas/CurrencyRoot' + description: Expected response, returns a list of currencies. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10230,26 +10173,70 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configuration by id + summary: Get currencies tags: - - Configurations + - Currencies x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationRoot + response-type: CurrencyRoot x-accepts: application/json - /analytics/lookups/v3/currencies: + /analytics/engines/pa/v3/dates: get: - description: This endpoint lists all the currencies that can be applied to any - calculation. - operationId: getCurrencies + 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 ( Account Name ending with .ACCT or .ACTM ) + explode: true + in: query + name: account + required: true + schema: + description: Account ( Account Name ending with .ACCT or .ACTM ) + example: Client:/Folder1/Folder2/AccountName.ACCT + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CurrencyRoot' - description: Expected response, returns a list of currencies. + $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. @@ -10285,270 +10272,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 - 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 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 ( Account Name ending with .ACCT or .ACTM ) - explode: true - in: query - name: account - required: true - schema: - description: Account ( Account Name ending with .ACCT or .ACTM ) - example: Client:/Folder1/Folder2/AccountName.ACCT - type: string - style: form - responses: - "200": - 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/ClientErrorResponse' + description: Invalid query parameter or value is provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -14200,9 +13929,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: @@ -14241,9 +13976,15 @@ 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. headers: @@ -19414,9 +19155,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 data provided. Please check the request parameters before attempting again. headers: @@ -19456,9 +19203,15 @@ 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: Template not found. headers: X-DataDirect-Request-Key: @@ -23050,275 +22803,287 @@ paths: style: simple "400": 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: 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 PA calculation by id - tags: - - PACalculations - 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 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/PACalculationParametersRoot' - description: Expected response, returns the PA 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: + 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 PA calculation by id + tags: + - PACalculations + 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 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/PACalculationParametersRoot' + description: Expected response, returns the PA 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. @@ -24651,57 +24416,49 @@ paths: - status-code: "200" response-type: ObjectRoot x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary: - post: - description: "This endpoint can be used to generate the PA portfolio commentary\ - \ based on a previous successful calculation.\r\n\r\nRemarks:\r\n\r\n*\tThe\ - \ PA component used in the calculation must be an attribution tile.\r\n \ - \ \r\n* The \"Variation in Average Weight\" column must be included along\ - \ with those required\r\n as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary)\r\ - \n in the component for successful commentary generation; otherwise, the\ - \ request will result in an error.\r\n\r\n* PA portfolio commentary generation\ - \ is not supported for multi-port requests.\r\n\r\n* The POST calculation\ - \ must use a single portfolio and a benchmark to generate the commentary.\r\ - \n\r\n* PA portfolio commentary with sub-period analysis will be returned\ - \ only when the frequency\r\n is set to something other than \"single\"\ - \ and the report contains more than one sub-period.\r\n \r\n* Commentary\ - \ customization is optional. Please include a configuration ID in the request\ - \ body when customization is desired. \r\n If the configuration ID is not\ - \ specified, the default commentary will be returned." - operationId: generatePAPortfolioCommentary + /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: Successful calculation id - explode: false - in: path - name: id - required: true + - description: PA pricing sources name + explode: true + in: query + name: name + required: false schema: - description: Successful calculation id + default: "" + description: PA pricing sources name type: string - style: simple - - description: Unit id associated with the successful calculation id - explode: false - in: path - name: unitId - required: true + style: form + - description: PA pricing sources category + explode: true + in: query + name: category + required: false schema: - description: Unit id associated with the successful calculation id + default: "" + description: PA pricing sources category type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PACommentaryParametersRoot' - description: Request Parameters + 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: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/PACommentaryRoot' - description: Expected response if the commentary generation is completed - in a short span, returns JSON. + $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. @@ -24719,6 +24476,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 @@ -24737,20 +24503,14 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: schema: - $ref: '#/components/schemas/PACommentaryGetStatusRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: - Location: - description: URL to poll for the resulting commentary - explode: false - schema: - description: URL to poll for the resulting commentary - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -24785,12 +24545,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Pricing sources not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -24882,9 +24642,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. @@ -24921,7 +24680,8 @@ paths: type: string style: simple "429": - description: Rate limit reached. 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. @@ -24939,24 +24699,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. @@ -25003,75 +24745,36 @@ paths: available after successful authentication. type: string style: simple - summary: Generate PA portfolio commentary by calculation and unit id. + summary: Get PA pricing sources tags: - - PACalculations - x-are-multiple-success-responses-different: true + - PricingSources + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "201" - response-type: PACommentaryRoot - - status-code: "202" - response-type: PACommentaryGetStatusRoot - x-contentType: application/json + - status-code: "200" + response-type: PAPricingSourceRoot x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status: + /analytics/engines/pub/v3/calculations: get: - description: "This endpoint allows you to check the progress of a previously\ - \ requested PA portfolio commentary. \r\nIf the commentary generation is complete,\ - \ the location header will provide the URL for the result." - operationId: getPAPortfolioCommentaryStatusById + description: This endpoints returns all calculation requests. + operationId: getAllCalculations parameters: - - description: Successful calculation id - explode: false - in: path - name: id - required: true - schema: - description: Successful calculation id - type: string - style: simple - - description: Unit id associated with the successful calculation id - explode: false - in: path - name: unitId - required: true + - explode: true + in: query + name: pageNumber + required: false schema: - description: Unit id associated with the successful calculation id - type: string - style: simple + default: 1 + format: int32 + type: integer + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PACommentaryStatusRoot' - description: Expected response once commentary is completed. + $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 @@ -25106,13 +24809,12 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: schema: - $ref: '#/components/schemas/PACommentaryGetStatusRoot' - description: Expected response returned if the commentary generation is - not yet completed, should contain X-FactSet-Api-PickUp-Progress header. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid page number. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25148,12 +24850,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: No calculation found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25209,7 +24911,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. @@ -25245,114 +24947,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 PA portfolio commentary status by calculation and unit id. - tags: - - PACalculations - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "200" - response-type: PACommentaryStatusRoot - - status-code: "202" - response-type: PACommentaryGetStatusRoot - x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result: - get: - description: "This endpoint retrieves the result of a previously requested portfolio\ - \ commentary. \r\nIf the commentary generation is complete, the commentary\ - \ will be returned in a predefined JSON format." - operationId: getPAPortfolioCommentaryResultById - parameters: - - description: Successful calculation id - explode: false - in: path - name: id - required: true - schema: - description: Successful calculation id - type: string - style: simple - - description: Unit id associated with the successful calculation id - explode: false - in: path - name: unitId - required: true - schema: - description: Unit id associated with the successful calculation id - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PACommentaryRoot' - description: Expected response once the commentary generation is completed, - returns JSON. + "406": + description: Unsupported Accept header. Header needs to be set to application/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 @@ -25387,12 +24984,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "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. @@ -25410,26 +25004,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. @@ -25447,9 +25050,62 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + 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. Example value is set to 10s. Please update it as per requirement + before triggering a calculation. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + example: 10 + 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. 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 @@ -25484,9 +25140,16 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25504,76 +25167,37 @@ 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 Portfolio commentary result by calculation and unit id. - tags: - - PACalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: PACommentaryRoot - 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": + 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: + application/pdf: schema: - $ref: '#/components/schemas/PAPricingSourceRoot' - description: Expected response, returns a list of PA pricing sources + 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25591,15 +25215,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 @@ -25620,11 +25235,13 @@ paths: style: simple "400": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + 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. @@ -25662,10 +25279,13 @@ paths: style: simple "404": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Pricing sources not found. + application/vnd.openxmlformats-officedocument.presentationml.presentation: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25757,8 +25377,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. @@ -25795,8 +25416,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. @@ -25814,6 +25435,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. @@ -25823,7 +25462,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. @@ -25860,35 +25499,38 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA pricing sources + summary: Create and Run Pub calculation tags: - - PricingSources - 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: PAPricingSourceRoot - x-accepts: application/json - /analytics/engines/pub/v3/calculations: - get: - description: This endpoints returns all calculation requests. - operationId: getAllCalculations + 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: - - explode: true - in: query - name: pageNumber - required: false + - 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: - default: 1 - format: int32 - type: integer - style: form + 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/CalculationsSummaryRoot' - description: List of calculation requests. + "204": + description: Expected response, calculation was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25926,10 +25568,16 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid page number. + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25967,756 +25615,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: No calculation 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 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. Example value is set to 10s. Please update it as per requirement - before triggering a calculation. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - example: 10 - 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: - "200": - content: - application/json: - 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 - 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/pdf: - 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. - 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": - content: - application/json: - 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 - 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 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 - "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": - content: - application/json: - 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 - "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. - 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 Pub calculation - tags: - - PubCalculations - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "201" - is-file: true - - status-code: "202" - response-type: CalculationStatusRoot - x-contentType: application/json - x-accepts: application/json - /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: 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: There was no request for the calculation identifier provided, - or the request was already canceled for the provided identifier. + 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. @@ -27167,14 +26076,20 @@ paths: $ref: '#/components/schemas/PubCalculationParametersRoot' description: Calculation Parameters responses: - "200": + "202": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + 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 @@ -27223,19 +26138,13 @@ paths: schema: type: string style: simple - "201": + "200": content: application/pdf: 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. + $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. @@ -27285,20 +26194,16 @@ paths: schema: type: string style: simple - "202": + "201": content: - application/json: - 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 + application/pdf: schema: - description: URL to poll for the resulting calculation + format: binary type: string - style: simple + 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. explode: false @@ -27349,7 +26254,7 @@ paths: style: simple "400": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid Calculation Parameters. @@ -27402,41 +26307,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 - 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 + "404": + content: + application/pdf: schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple - "403": - description: User is forbidden with current credentials + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27486,12 +26362,12 @@ paths: schema: type: string style: simple - "404": + "409": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + description: Duplicate calculation exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27541,12 +26417,41 @@ 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' - description: Duplicate calculation exists with same parameters. + 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. @@ -27779,14 +26684,14 @@ paths: - 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 - - status-code: "202" - response-type: CalculationStatusRoot x-contentType: application/json - x-accepts: 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\ @@ -28012,219 +26917,27 @@ 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 - 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 Pub calculation status 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 - 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 - parameters: - - 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 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: - "200": - content: - application/pdf: - schema: - format: binary - type: string - application/vnd.openxmlformats-officedocument.presentationml.presentation: - 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 - 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: + "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. @@ -28260,8 +26973,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. @@ -28279,8 +26993,153 @@ 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 Pub calculation status 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 + 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 + parameters: + - 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 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: + "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 + 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' + application/pdf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28321,6 +27180,12 @@ paths: 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 headers: @@ -28358,6 +27223,62 @@ 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 + 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 @@ -29250,9 +28171,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: @@ -29291,9 +28218,15 @@ 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. headers: @@ -31996,9 +30929,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: @@ -32037,9 +30976,15 @@ 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. headers: @@ -33238,455 +32183,28 @@ 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 SPAR calculation status by id - tags: - - SPARCalculations - 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/spar/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 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 - explode: false - in: path - name: unitId - required: true - schema: - description: from url, provided from the location header in the Get SPAR - 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. - 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' - application/x-protobuf: - 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' - 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. - 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 SPAR calculation result by id - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - x-accepts: application/json - /analytics/engines/axp/v3/strategies/{path}: - get: - description: This endpoint looks up all Axioma Equity strategy documents and - sub-directories in a given directory. - operationId: getAxiomaEquityStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - description: The directory to get the strategy documents and sub-directories - in - example: 'Client:' - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma Equity strategy - 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: + "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: - $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 + "503": + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33704,27 +32222,82 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + summary: Get SPAR calculation status by id + tags: + - SPARCalculations + 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/spar/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 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 + explode: false + in: path + name: unitId + required: true + schema: + description: from url, provided from the location header in the Get SPAR + 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. 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 - "401": - description: Missing or invalid authentication - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -33741,8 +32314,33 @@ 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' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33778,8 +32376,16 @@ 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' + 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. @@ -33815,9 +32421,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. @@ -33835,9 +32440,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 @@ -33863,7 +32498,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. @@ -33881,19 +32516,19 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma Equity strategy documents and sub-directories in a directory + summary: Get SPAR calculation result by id tags: - - StrategyDocuments + - SPARCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: ObjectRoot x-accepts: application/json - /analytics/engines/afi/v3/strategies/{path}: + /analytics/engines/axp/v3/strategies/{path}: get: - description: This endpoint looks up all Axioma FI strategy documents and sub-directories - in a given directory. - operationId: getAxiomaFIStrategyDocuments + description: This endpoint looks up all Axioma Equity strategy documents and + sub-directories in a given directory. + operationId: getAxiomaEquityStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -33913,8 +32548,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma FI strategy documents - and directories + description: Expected response, returns a list of Axioma Equity strategy + documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34191,7 +32826,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma FI strategy documents and sub-directories in a directory + summary: Get Axioma Equity strategy documents and sub-directories in a directory tags: - StrategyDocuments x-are-multiple-success-responses-different: false @@ -34199,11 +32834,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/bpm/v3/strategies/{path}: + /analytics/engines/afi/v3/strategies/{path}: get: - description: This endpoint looks up all Barra strategy documents and sub-directories + description: This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory. - operationId: getBarraStrategyDocuments + operationId: getAxiomaFIStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -34223,7 +32858,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 Axioma FI strategy documents and directories headers: X-DataDirect-Request-Key: @@ -34501,7 +33136,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Barra 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 @@ -34509,11 +33144,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/npo/v3/strategies/{path}: + /analytics/engines/bpm/v3/strategies/{path}: get: - description: This endpoint looks up all Northfield strategy documents and sub-directories + description: This endpoint looks up all Barra strategy documents and sub-directories in a given directory. - operationId: getNorthfieldStrategyDocuments + operationId: getBarraStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -34533,7 +33168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Northfield strategy documents + description: Expected response, returns a list of Barra strategy documents and directories headers: X-DataDirect-Request-Key: @@ -34811,7 +33446,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Northfield 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 @@ -34819,11 +33454,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/fpo/v3/strategies/{path}: + /analytics/engines/npo/v3/strategies/{path}: get: - description: This endpoint looks up all FactSet Portfolio Optimizer strategy - documents and sub-directories in a given directory. - operationId: getFPOStrategyDocuments + description: This endpoint looks up all Northfield strategy documents and sub-directories + in a given directory. + operationId: getNorthfieldStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -34843,8 +33478,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of FactSet Portfolio Optimizer - strategy documents and directories + description: Expected response, returns a list of Northfield strategy documents + and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35121,8 +33756,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get FactSet Portfolio Optimizer 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 @@ -35130,28 +33764,32 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pa/v3/templated-components: + /analytics/engines/fpo/v3/strategies/{path}: get: - description: This endpoint returns the list of templated PA components in path. - operationId: getTemplatedPAComponentsInPath + description: This endpoint looks up all FactSet Portfolio Optimizer strategy + documents and sub-directories in a given directory. + operationId: getFPOStrategyDocuments parameters: - - description: Get templated PA components in path - explode: true - in: query - name: directory + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path required: true schema: - description: Get templated PA components in path - example: Personal:TemplatedPAComponents/ + description: The directory to get the strategy documents and sub-directories + in + example: 'Client:' type: string - style: form + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' - description: Expected response, returns a list templated PA components. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + 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. @@ -35192,8 +33830,48 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + 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 headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35230,7 +33908,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. @@ -35286,7 +33964,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. @@ -35351,7 +34029,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. @@ -35370,7 +34048,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. @@ -35388,50 +34066,37 @@ paths: available after successful authentication. type: string style: simple - summary: Get templated PA components in path + summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories + in a directory tags: - - TemplatedPAComponents + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: TemplatedPAComponentSummaryRoot + response-type: DocumentDirectoriesRoot 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* Account identifiers must have .ACCT or .ACTM extension\ - \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ - \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ - \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ - \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ - \n* Multi-horizon frequencies are not supported through this endpoint.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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: + 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 + example: Personal:TemplatedPAComponents/ + type: string + style: form responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' - description: Expected response, templated PA component created successfully. + $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' + description: Expected response, returns a list templated PA components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35565,43 +34230,6 @@ paths: schema: type: string style: simple - "404": - 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 "406": description: Unsupported Accept header. Header needs to be set to application/json. headers: @@ -35705,33 +34333,56 @@ paths: available after successful authentication. type: string style: simple - summary: Create templated PA component + summary: Get templated PA components in path 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: "200" + response-type: TemplatedPAComponentSummaryRoot x-accepts: application/json - /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 + 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* Account identifiers must have .ACCT or .ACTM extension\ + \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ + \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ + \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ + \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ + \n* Multi-horizon frequencies are not supported through this endpoint.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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 - 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. + "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. @@ -35769,9 +34420,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 data provided. Please check the request parameters before attempting again. headers: @@ -35809,12 +34466,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Component not found. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35832,45 +34485,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: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36009,16 +34662,19 @@ paths: available after successful authentication. type: string style: simple - summary: Delete templated PA component + summary: Create templated PA component tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "201" + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json x-accepts: application/json - get: - description: This endpoint fetches the templated PA component settings. - operationId: getTemplatedPAComponentById + /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 @@ -36031,12 +34687,8 @@ paths: type: string style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentRoot' - description: Expected response, templated PA component details. + "204": + description: Expected response, deleted the templated PA component successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36074,9 +34726,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 data provided. Please check the request parameters before attempting again. headers: @@ -36116,10 +34774,16 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Templated PA component not found. + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36314,36 +34978,16 @@ paths: available after successful authentication. type: string style: simple - summary: Get templated PA component by id + summary: Delete templated PA component tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: TemplatedPAComponentRoot + - status-code: "204" 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* Account identifiers must have .ACCT or .ACTM\ - \ extension or BENCH: prefix. Holdings mode can be optionally set for every\ - \ account. \r\n Possible values for holdings mode are B&H (Buy and Hold),\ - \ TBR (Transaction based returns), OMS (Order Management System), \r\n \ - \ VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode\ - \ value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through\ - \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall,\ - \ and totals levels of granularity. However, if no value is passed, the default\ - \ value is 'securities'.\r\n Additionally, while 'groupsall' returns all\ - \ the group levels in the PA component,\r\n setting componentdetail to\ - \ 'groups' only returns the expanded or collapsed group levels within the\ - \ PA component.\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 grouping\ - \ frequency without overriding the group id it will not be applied to the\ - \ default groupings saved to the original component." - operationId: updateTemplatedPAComponents + get: + description: This endpoint fetches the templated PA component settings. + operationId: getTemplatedPAComponentById parameters: - description: Unique identifier for a templated PA component explode: false @@ -36355,20 +34999,13 @@ paths: 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/TemplatedPAComponentPostSummaryRoot' - description: Expected response, updated successfully. + $ref: '#/components/schemas/TemplatedPAComponentRoot' + description: Expected response, templated PA component details. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36451,7 +35088,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Component or template not found. + description: Templated PA component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36646,47 +35283,61 @@ paths: available after successful authentication. type: string style: simple - summary: Update 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: "200" - response-type: TemplatedPAComponentPostSummaryRoot - x-contentType: application/json + response-type: TemplatedPAComponentRoot x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates: - get: - description: This endpoint returns the list of unlinked PA templates. - operationId: getUnlinkedPATemplates + 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* Account identifiers must have .ACCT or .ACTM\ + \ extension or BENCH: prefix. Holdings mode can be optionally set for every\ + \ account. \r\n Possible values for holdings mode are B&H (Buy and Hold),\ + \ TBR (Transaction based returns), OMS (Order Management System), \r\n \ + \ VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode\ + \ value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through\ + \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall,\ + \ and totals levels of granularity. However, if no value is passed, the default\ + \ value is 'securities'.\r\n Additionally, while 'groupsall' returns all\ + \ the group levels in the PA component,\r\n setting componentdetail to\ + \ 'groups' only returns the expanded or collapsed group levels within the\ + \ PA component.\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 grouping\ + \ frequency without overriding the group id it will not be applied to the\ + \ default groupings saved to the original component." + operationId: updateTemplatedPAComponents parameters: - - description: Get unlinked PA templates in path. - explode: true - in: query - name: directory - required: false - schema: - description: Get unlinked PA templates in path. - example: Personal:UninkedPATemplates/ - type: string - style: form - - description: Get unlinked PA templates by category. - explode: true - in: query - name: category - required: false + - description: Unique identifier for a templated PA component + explode: false + in: path + name: id + required: true schema: - description: Get unlinked PA templates by category. - example: Weights + description: Unique identifier for a templated PA component + example: "01234567890123456789012345678901" type: string - style: form + 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/UnlinkedPATemplateSummaryRoot' - description: Expected response, returns a list of unlinked PA templates. + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + description: Expected response, updated successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36764,6 +35415,47 @@ 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: @@ -36923,57 +35615,47 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA templates + summary: Update templated PA component tags: - - UnlinkedPATemplates + - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: UnlinkedPATemplateSummaryRoot + response-type: TemplatedPAComponentPostSummaryRoot + 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* Account identifiers must have .ACCT\ - \ or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set\ - \ for every account. \r\n Possible values for holdings mode are B&H (Buy\ - \ and Hold), TBR (Transaction based returns), OMS (Order Management System),\ - \ \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings\ - \ mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported\ - \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ - \ groupsall, and totals levels of granularity. However, if no value is passed,\ - \ the default value is 'securities'.\r\n Additionally, while 'groupsall'\ - \ returns all the group levels in the PA component,\r\n setting componentdetail\ - \ to 'groups' only returns the expanded or collapsed group levels within the\ - \ PA component.\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 grouping\ - \ 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 + /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. + example: Personal:UninkedPATemplates/ + 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. + example: Weights + type: string + style: form responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, created a unlinked PA template. + $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. @@ -37210,75 +35892,57 @@ paths: available after successful authentication. type: string style: simple - summary: Create unlinked PA template + summary: Get unlinked PA templates 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: "200" + response-type: UnlinkedPATemplateSummaryRoot x-accepts: application/json - /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 + 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* Account identifiers must have .ACCT\ + \ or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set\ + \ for every account. \r\n Possible values for holdings mode are B&H (Buy\ + \ and Hold), TBR (Transaction based returns), OMS (Order Management System),\ + \ \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings\ + \ mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported\ + \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ + \ groupsall, and totals levels of granularity. However, if no value is passed,\ + \ the default value is 'securities'.\r\n Additionally, while 'groupsall'\ + \ returns all the group levels in the PA component,\r\n setting componentdetail\ + \ to 'groups' only returns the expanded or collapsed group levels within the\ + \ PA component.\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 grouping\ + \ 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 - 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. - 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": + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, created a unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -37314,12 +35978,13 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Template not found. + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -37514,16 +36179,19 @@ paths: available after successful authentication. type: string style: simple - summary: Delete unlinked PA template + summary: Create unlinked PA template tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "201" + response-type: UnlinkedPATemplatePostSummaryRoot + x-contentType: application/json x-accepts: application/json - get: - description: This endpoint fetches the template settings. - operationId: getUnlinkedPATemplatesById + /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 @@ -37536,12 +36204,8 @@ paths: type: string style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplateRoot' - description: Expected response, get details of the unlinked PA template. + "204": + description: Expected response, deleted the unlinked PA template successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -37819,43 +36483,16 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA template details by id + summary: Delete unlinked PA template tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: UnlinkedPATemplateRoot + - status-code: "204" 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* Account identifiers must have .ACCT or .ACTM extension\ - \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ - \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ - \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ - \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ - \n* Multi-horizon frequencies are not supported through this endpoint.\r\ - \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ - \ levels of granularity. However, if no value is passed, the default value\ - \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ - \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ - \ only returns the expanded or collapsed group levels within the PA component.\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 grouping frequency\ - \ without overriding the group id it will not be applied to the default groupings\ - \ saved to the original component." - operationId: updateUnlinkedPATemplates + get: + description: This endpoint fetches the template settings. + operationId: getUnlinkedPATemplatesById parameters: - description: Unique identifier for an unlinked PA template explode: false @@ -37867,20 +36504,13 @@ paths: 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/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, updated the unlinked PA template. + $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. @@ -38158,82 +36788,68 @@ paths: available after successful authentication. type: string style: simple - summary: Update 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: "200" - response-type: UnlinkedPATemplatePostSummaryRoot - x-contentType: application/json + response-type: UnlinkedPATemplateRoot x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates/template-types: - get: - description: This endpoint fetches default unlinked PA template types. - operationId: getDefaultUnlinkedPATemplateTypes + 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* Account identifiers must have .ACCT or .ACTM extension\ + \ or BENCH: prefix. Holdings mode can be optionally set for every account.\ + \ \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction\ + \ based returns), OMS (Order Management System), \r\n VLT (Vaulted returns)\ + \ or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\ + \n* Multi-horizon frequencies are not supported through this endpoint.\r\ + \n\r\n* Componentdetail supports securities, groups, groupsall, and totals\ + \ levels of granularity. However, if no value is passed, the default value\ + \ is 'securities'.\r\n Additionally, while 'groupsall' returns all the\ + \ group levels in the PA component,\r\n setting componentdetail to 'groups'\ + \ only returns the expanded or collapsed group levels within the PA component.\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 grouping 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 + 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/UnlinkedPATemplateCategoryAndTypeRoot' - description: Expected response, default unlinked PA template types - 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 + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, updated the unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -38269,8 +36885,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. @@ -38306,9 +36927,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. + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -38326,16 +36950,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. + 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. @@ -38353,8 +36987,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -38372,35 +37006,26 @@ paths: 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: + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false schema: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot' - description: Expected response, details of the unlinked PA template type + 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. @@ -38436,13 +37061,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. @@ -38460,30 +37081,72 @@ 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 - "404": + "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": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Unlinked PA template type not found. + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' + description: Expected response, default unlinked PA template types headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -38678,48 +37341,35 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA template type details by id. + 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: UnlinkedPATemplateCategoryAndTypeDetailsRoot + response-type: UnlinkedPATemplateCategoryAndTypeRoot x-accepts: application/json - /analytics/engines/vault/v3/load/{batchId}: - post: - description: This endpoint loads Vault External Attributions. - operationId: vaultAttributionLoader + /analytics/engines/pa/v3/unlinked-templates/template-types/{id}: + get: + description: This endpoint fetches the unlinked PA template type details. + operationId: getDetailsType parameters: - - explode: false + - description: Unique identifier for an unlinked PA template type + explode: false in: path - name: batchId + name: id 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/VaultAttributionLoaderResponseRoot' - description: Expected response, returns a status of operation along with - errors and warnings if found any. + $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. @@ -38760,7 +37410,49 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Bad Request + 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -38955,14 +37647,13 @@ paths: available after successful authentication. type: string style: simple - summary: Vault - External Attribution Loader + summary: Get unlinked PA template type details by id. tags: - - Vault Attribution Loader + - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultAttributionLoaderResponseRoot - x-contentType: multipart/form-data + response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot x-accepts: application/json /analytics/engines/vault/v3/calculations: get: @@ -39779,9 +38470,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: @@ -39820,9 +38517,15 @@ 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. headers: @@ -41363,12 +40066,6 @@ paths: response-type: ObjectRoot x-accepts: application/json components: - requestBodies: - inline_object: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/inline_object' schemas: ReturnType: example: @@ -41450,7 +40147,6 @@ components: type: array type: object AccountDirectories: - description: List of the accounts and directories. example: directories: - directories @@ -42684,35 +41380,6 @@ components: required: - data type: object - PACommentaryConfigurationSummary: - example: - name: name - directory: directory - properties: - name: - description: PA commentary configuration name - type: string - directory: - description: PA Commentary configuration directory - type: string - type: object - PACommentaryConfigurationSummaryRoot: - example: - data: - key: - name: name - directory: directory - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/PACommentaryConfigurationSummary' - type: object - meta: - type: object - required: - - data - type: object ConfigurationAccount: example: maxEndDate: maxEndDate @@ -42783,7 +41450,6 @@ components: - data type: object Currency: - description: Details of the currency. example: name: name properties: @@ -43285,58 +41951,13 @@ components: - OAS type: string type: object - FIConvertibleSettings: - example: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 - properties: - equityPrice: - description: Equity Price - format: double - type: number - equityIndexVolatility: - description: Equity Index Volatility - format: double - type: number - equityDividendYield: - description: Equity Dividend Yield - format: double - type: number - volatilityCapMethod: - description: Volatility CapMethod - enum: - - noCap - - specifiedRate - - multiplier - type: string - volatilityCapMethodValue: - description: Volatility CapMethod Value - (Required only when volatilityCapMethod - is specifiedRate or multiplier) - format: double - type: number - equityExchangeRate: - description: Equity Exchange Rate - format: double - type: number - type: object FISecurity: example: callMethod: No Call symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -43375,7 +41996,7 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 9.965781217890562 + face: 6.84685269835264 municipalBonds: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -43420,8 +42041,6 @@ components: $ref: '#/components/schemas/FIStructuredProductsForSecurities' attribution: $ref: '#/components/schemas/FIAttributionForSecurities' - convertible: - $ref: '#/components/schemas/FIConvertibleSettings' calcFromMethod: description: "Calculation Method.\r\nMethods : Active Spread, Actual Spread,\ \ Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act\ @@ -43585,8 +42204,8 @@ components: bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 9 - - 9 + - 7 + - 7 settlement: settlement properties: asOfDate: @@ -43666,8 +42285,8 @@ components: bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 9 - - 9 + - 7 + - 7 settlement: settlement calculations: - calculations @@ -43677,14 +42296,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -43723,7 +42335,7 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 9.965781217890562 + face: 6.84685269835264 municipalBonds: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -43738,14 +42350,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -43784,7 +42389,7 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 9.965781217890562 + face: 6.84685269835264 municipalBonds: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -43896,8 +42501,8 @@ components: bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 9 - - 9 + - 7 + - 7 settlement: settlement calculations: - calculations @@ -43907,14 +42512,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -43953,7 +42551,7 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 9.965781217890562 + face: 6.84685269835264 municipalBonds: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -43968,14 +42566,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 5.025004791520295 - convertible: - volatilityCapMethodValue: 1.1730742509559433 - equityPrice: 1.4894159098541704 - volatilityCapMethod: noCap - equityExchangeRate: 4.965218492984954 - equityDividendYield: 7.457744773683766 - equityIndexVolatility: 6.84685269835264 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -44014,7 +42605,7 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 9.965781217890562 + face: 6.84685269835264 municipalBonds: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -44921,7 +43512,6 @@ components: $ref: '#/components/schemas/CalculationMeta' type: object CalculationUnitStatus: - description: The status of the calculation as per FactSets API standards example: result: result warnings: @@ -44977,7 +43567,6 @@ components: type: array type: object CalculationStatus: - description: Details of the calculation. example: calculationid: calculationid units: @@ -45024,7 +43613,6 @@ components: type: object type: object CalculationUnitStatusMeta: - description: Meta of the calculation unit. example: info: info properties: @@ -45033,7 +43621,6 @@ components: type: string type: object CalculationStatusMeta: - description: Meta of calculation units in batch. example: units: key: @@ -45042,7 +43629,7 @@ components: units: additionalProperties: $ref: '#/components/schemas/CalculationUnitStatusMeta' - description: List of calculation units in batch. + description: Meta of calculation units in batch. type: object type: object CalculationStatusRoot: @@ -45179,265 +43766,6 @@ components: required: - data type: object - PACommentaryParameters: - example: - configurationid: configurationid - properties: - configurationid: - description: Commentary configuration id - type: string - type: object - PACommentaryParametersRoot: - example: - data: - configurationid: configurationid - meta: '{}' - properties: - data: - $ref: '#/components/schemas/PACommentaryParameters' - meta: - type: object - required: - - data - type: object - PACommentaryDate: - example: - yyyymmdd: 0 - relative: relative - properties: - yyyymmdd: - description: Date can be either absolute (YYYYMMDD) or relative, but only - one format should be set at a time. - format: int32 - type: integer - relative: - description: Date can be either relative or absolute (YYYYMMDD), but only - one format should be set at a time. - type: string - type: object - Metadata: - example: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - properties: - tileName: - description: PA Tile name associated with the component - type: string - portfolioDescription: - description: Portfolio name used in generating commentary - type: string - benchmarkDescription: - description: Benchmark name used in generating commentary - type: string - startDate: - $ref: '#/components/schemas/PACommentaryDate' - endDate: - $ref: '#/components/schemas/PACommentaryDate' - frequency: - description: Date frequency - type: string - type: object - Section: - example: - metadata: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - subSections: - - null - - null - title: title - content: content - properties: - metadata: - $ref: '#/components/schemas/Metadata' - title: - description: Commentary title - type: string - content: - description: Generated commentary content - type: string - subSections: - description: Generated commentary subsections - items: - $ref: '#/components/schemas/Section' - type: array - type: object - PACommentary: - example: - commentaryId: commentaryId - sections: - - metadata: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - subSections: - - null - - null - title: title - content: content - - metadata: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - subSections: - - null - - null - title: title - content: content - disclaimer: disclaimer - properties: - commentaryId: - description: Generated commentary Id - type: string - sections: - description: Commentary sections - items: - $ref: '#/components/schemas/Section' - type: array - disclaimer: - description: Disclaimer - type: string - type: object - PACommentaryRoot: - example: - data: - commentaryId: commentaryId - sections: - - metadata: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - subSections: - - null - - null - title: title - content: content - - metadata: - benchmarkDescription: benchmarkDescription - endDate: - yyyymmdd: 0 - relative: relative - portfolioDescription: portfolioDescription - startDate: - yyyymmdd: 0 - relative: relative - tileName: tileName - frequency: frequency - subSections: - - null - - null - title: title - content: content - disclaimer: disclaimer - meta: '{}' - properties: - data: - $ref: '#/components/schemas/PACommentary' - meta: - type: object - required: - - data - type: object - PACommentaryGetStatus: - properties: - calculationid: - description: Calculation id. - type: string - unitid: - description: Calculation unit id. - type: string - status: - description: The status of commentary generation. - enum: - - Executing - - Success - type: string - type: object - PACommentaryGetStatusRoot: - properties: - data: - $ref: '#/components/schemas/PACommentaryGetStatus' - meta: - type: object - required: - - data - type: object - PACommentaryStatus: - example: - result: result - calculationid: calculationid - unitid: unitid - status: Executing - properties: - result: - description: The result url of the generated commentary. - type: string - calculationid: - description: Calculation id. - type: string - unitid: - description: Calculation unit id. - type: string - status: - description: The status of commentary generation. - enum: - - Executing - - Success - type: string - type: object - PACommentaryStatusRoot: - example: - data: - result: result - calculationid: calculationid - unitid: unitid - status: Executing - meta: '{}' - properties: - data: - $ref: '#/components/schemas/PACommentaryStatus' - meta: - type: object - required: - - data - type: object PAPricingSource: example: name: name @@ -45697,6 +44025,133 @@ components: - expr - name type: object + QuantScreeningExpressionUniverseObsolete: + properties: + universeExpr: + type: string + universeType: + enum: + - Equity + - Debt + type: string + securityExpr: + type: string + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse + type: string + required: + - universeExpr + - universeType + type: object + QuantUniversalScreenUniverseObsolete: + properties: + screen: + type: string + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse + type: string + required: + - screen + type: object + QuantIdentifierUniverseObsolete: + properties: + universeType: + enum: + - Equity + - Debt + type: string + identifiers: + items: + type: string + type: array + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse + type: string + required: + - identifiers + - universeType + type: object + QuantFdsDateObsolete: + properties: + startDate: + type: string + endDate: + type: string + frequency: + type: string + calendar: + type: string + overrideUniversalScreenCalendar: + type: boolean + required: + - calendar + - endDate + - frequency + - startDate + type: object + QuantDateListObsolete: + properties: + dates: + items: + type: string + type: array + frequency: + type: string + calendar: + type: string + overrideUniversalScreenCalendar: + type: boolean + required: + - calendar + - frequency + type: object + QuantScreeningExpressionObsolete: + properties: + expr: + type: string + name: + type: string + dateOffset: + type: string + required: + - expr + - name + type: object + QuantFqlExpressionObsolete: + properties: + expr: + type: string + name: + type: string + dateOffset: + type: string + isArrayReturnType: + type: boolean + required: + - expr + - name + type: object + QuantUniversalScreenParameterObsolete: + properties: + referenceName: + type: string + name: + type: string + required: + - name + - referenceName + type: object + QuantAllUniversalScreenParametersObsolete: + type: object OneOfQuantUniverse: discriminator: mapping: @@ -45828,7 +44283,6 @@ components: example: enddate: enddate startdate: startdate - useeachportfolioinception: true frequency: frequency properties: startdate: @@ -45840,9 +44294,6 @@ components: frequency: description: Calculation's frequency. type: string - useeachportfolioinception: - description: Use Each Portfolio Inception - type: boolean required: - enddate - frequency @@ -45855,7 +44306,6 @@ components: dates: enddate: enddate startdate: startdate - useeachportfolioinception: true frequency: frequency accounts: - prefix: prefix @@ -45896,7 +44346,6 @@ components: dates: enddate: enddate startdate: startdate - useeachportfolioinception: true frequency: frequency accounts: - prefix: prefix @@ -47123,37 +45572,6 @@ 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: example: componentdetail: componentdetail @@ -47212,13 +45630,6 @@ 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/AccountDirectories.md b/auto-generated-sdk/docs/AccountDirectories.md index 76f04c90..e5acfb04 100644 --- a/auto-generated-sdk/docs/AccountDirectories.md +++ b/auto-generated-sdk/docs/AccountDirectories.md @@ -2,7 +2,6 @@ # AccountDirectories -List of the accounts and directories. ## Properties diff --git a/auto-generated-sdk/docs/CalculationStatus.md b/auto-generated-sdk/docs/CalculationStatus.md index 0a173c64..bde2407b 100644 --- a/auto-generated-sdk/docs/CalculationStatus.md +++ b/auto-generated-sdk/docs/CalculationStatus.md @@ -2,7 +2,6 @@ # CalculationStatus -Details of the calculation. ## Properties diff --git a/auto-generated-sdk/docs/CalculationStatusMeta.md b/auto-generated-sdk/docs/CalculationStatusMeta.md index b257831d..c53e9b8f 100644 --- a/auto-generated-sdk/docs/CalculationStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationStatusMeta.md @@ -2,13 +2,12 @@ # CalculationStatusMeta -Meta of calculation units in batch. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**units** | [**Map<String, CalculationUnitStatusMeta>**](CalculationUnitStatusMeta.md) | List of calculation units in batch. | [optional] +**units** | [**Map<String, CalculationUnitStatusMeta>**](CalculationUnitStatusMeta.md) | Meta of calculation units in batch. | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index 03346392..bdb23f1b 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -2,7 +2,6 @@ # CalculationUnitStatus -The status of the calculation as per FactSets API standards ## Properties diff --git a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md index 5ca0a7e7..cb98ad77 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md @@ -2,7 +2,6 @@ # CalculationUnitStatusMeta -Meta of the calculation unit. ## Properties diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index 49881302..c8b42022 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -380,7 +380,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ComponentsApi apiInstance = new ComponentsApi(defaultClient); - String id = "AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D"; // String | Unique identifier for a vault component + String id = "id_example"; // String | Unique identifier for a vault component try { VaultComponentRoot result = apiInstance.getVaultComponentById(id); System.out.println(result); @@ -463,7 +463,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ComponentsApi apiInstance = new ComponentsApi(defaultClient); - String document = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT"; // String | Document Name + String document = "document_example"; // String | Document Name try { ComponentSummaryRoot result = apiInstance.getVaultComponents(document); System.out.println(result); diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index e7653abe..b52d6293 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -5,94 +5,11 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**getPACommentaryConfigurations**](ConfigurationsApi.md#getPACommentaryConfigurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory [**getVaultConfigurationById**](ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id [**getVaultConfigurations**](ConfigurationsApi.md#getVaultConfigurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations -## getPACommentaryConfigurations - -> PACommentaryConfigurationSummaryRoot getPACommentaryConfigurations(path) - -Get PA commentary configurations in a directory - -This endpoint returns all PA commentary configurations 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.ConfigurationsApi; - -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"); - - ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); - String path = "Client:"; // String | The directory to get the PA commentary configurations - try { - PACommentaryConfigurationSummaryRoot result = apiInstance.getPACommentaryConfigurations(path); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ConfigurationsApi#getPACommentaryConfigurations"); - 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 PA commentary configurations | - -### Return type - -[**PACommentaryConfigurationSummaryRoot**](PACommentaryConfigurationSummaryRoot.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 map of configuration ID to PA commentary configuration | * 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 path 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.
| -| **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.
| - - ## getVaultConfigurationById > VaultConfigurationRoot getVaultConfigurationById(id) @@ -127,7 +44,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); - String id = "e95ef921-b4d4-4bb7-93ba-60eca8e3247a"; // String | Vault configuration id to get the details of + String id = "id_example"; // String | Vault configuration id to get the details of try { VaultConfigurationRoot result = apiInstance.getVaultConfigurationById(id); System.out.println(result); @@ -210,7 +127,7 @@ public class Example { Bearer.setBearerToken("BEARER TOKEN"); ConfigurationsApi apiInstance = new ConfigurationsApi(defaultClient); - String account = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT"; // String | Required account query parameter to filter configurations for a specific account + String account = "account_example"; // String | Required account query parameter to filter configurations for a specific account try { VaultConfigurationSummaryRoot result = apiInstance.getVaultConfigurations(account); System.out.println(result); diff --git a/auto-generated-sdk/docs/Currency.md b/auto-generated-sdk/docs/Currency.md index beb4b550..c9f91057 100644 --- a/auto-generated-sdk/docs/Currency.md +++ b/auto-generated-sdk/docs/Currency.md @@ -2,7 +2,6 @@ # Currency -Details of the currency. ## Properties diff --git a/auto-generated-sdk/docs/FIConvertibleSettings.md b/auto-generated-sdk/docs/FIConvertibleSettings.md deleted file mode 100644 index 8ea9c4a7..00000000 --- a/auto-generated-sdk/docs/FIConvertibleSettings.md +++ /dev/null @@ -1,32 +0,0 @@ - - -# FIConvertibleSettings - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**equityPrice** | **Double** | Equity Price | [optional] -**equityIndexVolatility** | **Double** | Equity Index Volatility | [optional] -**equityDividendYield** | **Double** | Equity Dividend Yield | [optional] -**volatilityCapMethod** | [**VolatilityCapMethodEnum**](#VolatilityCapMethodEnum) | Volatility CapMethod | [optional] -**volatilityCapMethodValue** | **Double** | Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) | [optional] -**equityExchangeRate** | **Double** | Equity Exchange Rate | [optional] - - - -## Enum: VolatilityCapMethodEnum - -Name | Value ----- | ----- -NOCAP | "noCap" -SPECIFIEDRATE | "specifiedRate" -MULTIPLIER | "multiplier" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index 8690f983..2f3695fb 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -18,7 +18,6 @@ Name | Type | Description | Notes **matrixMultiplier** | **Double** | Matrix Multiplier | [optional] **structuredProducts** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] **attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] -**convertible** | [**FIConvertibleSettings**](FIConvertibleSettings.md) | | [optional] **calcFromMethod** | **String** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] **calcFromValue** | **Double** | Calculation from value | **face** | **Double** | Face | [optional] diff --git a/auto-generated-sdk/docs/FiCalculationsApi.md b/auto-generated-sdk/docs/FiCalculationsApi.md index e12a01cd..410f3763 100644 --- a/auto-generated-sdk/docs/FiCalculationsApi.md +++ b/auto-generated-sdk/docs/FiCalculationsApi.md @@ -80,7 +80,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md index 7318bc56..38d7bbe5 100644 --- a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md +++ b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md @@ -175,7 +175,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/Metadata.md b/auto-generated-sdk/docs/Metadata.md deleted file mode 100644 index 2384faca..00000000 --- a/auto-generated-sdk/docs/Metadata.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Metadata - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tileName** | **String** | PA Tile name associated with the component | [optional] -**portfolioDescription** | **String** | Portfolio name used in generating commentary | [optional] -**benchmarkDescription** | **String** | Benchmark name used in generating commentary | [optional] -**startDate** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] -**endDate** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] -**frequency** | **String** | Date frequency | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentary.md b/auto-generated-sdk/docs/PACommentary.md deleted file mode 100644 index b5d0425f..00000000 --- a/auto-generated-sdk/docs/PACommentary.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# PACommentary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**commentaryId** | **String** | Generated commentary Id | [optional] -**sections** | [**java.util.List<Section>**](Section.md) | Commentary sections | [optional] -**disclaimer** | **String** | Disclaimer | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md deleted file mode 100644 index 6db2df86..00000000 --- a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryConfigurationSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | PA commentary configuration name | [optional] -**directory** | **String** | PA Commentary configuration directory | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md deleted file mode 100644 index f17234b9..00000000 --- a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryConfigurationSummaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**Map<String, PACommentaryConfigurationSummary>**](PACommentaryConfigurationSummary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryDate.md b/auto-generated-sdk/docs/PACommentaryDate.md deleted file mode 100644 index ed8f20f4..00000000 --- a/auto-generated-sdk/docs/PACommentaryDate.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryDate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**yyyymmdd** | **Integer** | Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. | [optional] -**relative** | **String** | Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryGetStatus.md b/auto-generated-sdk/docs/PACommentaryGetStatus.md deleted file mode 100644 index e190118a..00000000 --- a/auto-generated-sdk/docs/PACommentaryGetStatus.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# PACommentaryGetStatus - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**calculationid** | **String** | Calculation id. | [optional] -**unitid** | **String** | Calculation unit id. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of commentary generation. | [optional] - - - -## Enum: StatusEnum - -Name | Value ----- | ----- -EXECUTING | "Executing" -SUCCESS | "Success" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md b/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md deleted file mode 100644 index 2cc1db71..00000000 --- a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryGetStatusRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PACommentaryGetStatus**](PACommentaryGetStatus.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryParametersRoot.md b/auto-generated-sdk/docs/PACommentaryParametersRoot.md deleted file mode 100644 index a5a98ab4..00000000 --- a/auto-generated-sdk/docs/PACommentaryParametersRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryParametersRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PACommentaryParameters**](PACommentaryParameters.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryRoot.md b/auto-generated-sdk/docs/PACommentaryRoot.md deleted file mode 100644 index 3ab6cd91..00000000 --- a/auto-generated-sdk/docs/PACommentaryRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# PACommentaryRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PACommentary**](PACommentary.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PACommentaryStatus.md b/auto-generated-sdk/docs/PACommentaryStatus.md deleted file mode 100644 index 9ddac8ab..00000000 --- a/auto-generated-sdk/docs/PACommentaryStatus.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# PACommentaryStatus - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result** | **String** | The result url of the generated commentary. | [optional] -**calculationid** | **String** | Calculation id. | [optional] -**unitid** | **String** | Calculation unit id. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of commentary generation. | [optional] - - - -## Enum: StatusEnum - -Name | Value ----- | ----- -EXECUTING | "Executing" -SUCCESS | "Success" - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/PaCalculationsApi.md b/auto-generated-sdk/docs/PaCalculationsApi.md index 782e3445..0f15dedd 100644 --- a/auto-generated-sdk/docs/PaCalculationsApi.md +++ b/auto-generated-sdk/docs/PaCalculationsApi.md @@ -6,13 +6,10 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**cancelCalculationById**](PaCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -[**generatePAPortfolioCommentary**](PaCalculationsApi.md#generatePAPortfolioCommentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. [**getAllCalculations**](PaCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations [**getCalculationParameters**](PaCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id [**getCalculationStatusById**](PaCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id [**getCalculationUnitResultById**](PaCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -[**getPAPortfolioCommentaryResultById**](PaCalculationsApi.md#getPAPortfolioCommentaryResultById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. -[**getPAPortfolioCommentaryStatusById**](PaCalculationsApi.md#getPAPortfolioCommentaryStatusById) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. [**postAndCalculate**](PaCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation [**putAndCalculate**](PaCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. @@ -84,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | @@ -98,111 +95,6 @@ null (empty response body) | **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.
| -## generatePAPortfolioCommentary - -> PACommentaryRoot generatePAPortfolioCommentary(id, unitId, paCommentaryParametersRoot) - -Generate PA portfolio commentary by calculation and unit id. - -This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. - -Remarks: - -* The PA component used in the calculation must be an attribution tile. - -* The "Variation in Average Weight" column must be included along with those required - as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) - in the component for successful commentary generation; otherwise, the request will result in an error. - -* PA portfolio commentary generation is not supported for multi-port requests. - -* The POST calculation must use a single portfolio and a benchmark to generate the commentary. - -* PA portfolio commentary with sub-period analysis will be returned only when the frequency - is set to something other than "single" and the report contains more than one sub-period. - -* Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. - If the configuration ID is not specified, the default commentary will be returned. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | Successful calculation id - String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id - PACommentaryParametersRoot paCommentaryParametersRoot = new PACommentaryParametersRoot(); // PACommentaryParametersRoot | Request Parameters - try { - Object result = apiInstance.generatePAPortfolioCommentary(id, unitId, paCommentaryParametersRoot); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#generatePAPortfolioCommentary"); - 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**| Successful calculation id | - **unitId** | **String**| Unit id associated with the successful calculation id | - **paCommentaryParametersRoot** | [**PACommentaryParametersRoot**](PACommentaryParametersRoot.md)| Request Parameters | [optional] - -### Return type - -(For 201 status - [**PACommentaryRoot**](PACommentaryRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.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 | -|-------------|-------------|------------------| -| **201** | Expected response if the commentary generation is completed in a short span, returns 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.
| -| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting commentary
* 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.
| -| **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. 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.
| - - ## getAllCalculations > CalculationsSummaryRoot getAllCalculations(pageNumber) @@ -535,173 +427,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.
| -## getPAPortfolioCommentaryResultById - -> PACommentaryRoot getPAPortfolioCommentaryResultById(id, unitId) - -Get PA Portfolio commentary result by calculation and unit id. - -This endpoint retrieves the result of a previously requested portfolio commentary. -If the commentary generation is complete, the commentary will be returned in a predefined JSON format. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | Successful calculation id - String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id - try { - PACommentaryRoot result = apiInstance.getPAPortfolioCommentaryResultById(id, unitId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#getPAPortfolioCommentaryResultById"); - 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**| Successful calculation id | - **unitId** | **String**| Unit id associated with the successful calculation id | - -### Return type - -[**PACommentaryRoot**](PACommentaryRoot.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 the commentary generation is completed, returns JSON. | * 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.
| -| **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.
| - - -## getPAPortfolioCommentaryStatusById - -> PACommentaryStatusRoot getPAPortfolioCommentaryStatusById(id, unitId) - -Get PA portfolio commentary status by calculation and unit id. - -This endpoint allows you to check the progress of a previously requested PA portfolio commentary. -If the commentary generation is complete, the location header will provide the URL for the result. - -### 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.PaCalculationsApi; - -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"); - - PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient); - String id = "id_example"; // String | Successful calculation id - String unitId = "unitId_example"; // String | Unit id associated with the successful calculation id - try { - Object result = apiInstance.getPAPortfolioCommentaryStatusById(id, unitId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling PaCalculationsApi#getPAPortfolioCommentaryStatusById"); - 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**| Successful calculation id | - **unitId** | **String**| Unit id associated with the successful calculation id | - -### Return type - -(For 200 status - [**PACommentaryStatusRoot**](PACommentaryStatusRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.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 commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * 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.
| -| **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, paCalculationParametersRoot) diff --git a/auto-generated-sdk/docs/PubCalculationsApi.md b/auto-generated-sdk/docs/PubCalculationsApi.md index 6ad0c8d7..42019817 100644 --- a/auto-generated-sdk/docs/PubCalculationsApi.md +++ b/auto-generated-sdk/docs/PubCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | @@ -412,16 +412,16 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/json +- **Accept**: application/json, application/x-protobuf, application/pdf ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | Expected response once calculation is completed, returns result 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.
| -| **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.
| | **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.
| @@ -489,7 +489,7 @@ Name | Type | Description | Notes ### Return type -(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) +(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) ### Authorization @@ -498,18 +498,18 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation +- **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### 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.
| -| **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.
| | **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.
| -| **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.
| | **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.
| @@ -585,7 +585,7 @@ Name | Type | Description | Notes ### Return type -(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) +(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) ### Authorization @@ -594,19 +594,19 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation +- **Accept**: application/pdf ### 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| -| **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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| +| **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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index 642fda84..ce27da35 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -82,7 +82,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/QuantDateListObsolete.md b/auto-generated-sdk/docs/QuantDateListObsolete.md new file mode 100644 index 00000000..9f60b98f --- /dev/null +++ b/auto-generated-sdk/docs/QuantDateListObsolete.md @@ -0,0 +1,20 @@ + + +# QuantDateListObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dates** | **java.util.List<String>** | | [optional] +**frequency** | **String** | | +**calendar** | **String** | | +**overrideUniversalScreenCalendar** | **Boolean** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantFdsDateObsolete.md b/auto-generated-sdk/docs/QuantFdsDateObsolete.md new file mode 100644 index 00000000..778d65d8 --- /dev/null +++ b/auto-generated-sdk/docs/QuantFdsDateObsolete.md @@ -0,0 +1,21 @@ + + +# QuantFdsDateObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startDate** | **String** | | +**endDate** | **String** | | +**frequency** | **String** | | +**calendar** | **String** | | +**overrideUniversalScreenCalendar** | **Boolean** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md new file mode 100644 index 00000000..cde3a56e --- /dev/null +++ b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md @@ -0,0 +1,20 @@ + + +# QuantFqlExpressionObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expr** | **String** | | +**name** | **String** | | +**dateOffset** | **String** | | [optional] +**isArrayReturnType** | **Boolean** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md new file mode 100644 index 00000000..383c9dd1 --- /dev/null +++ b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md @@ -0,0 +1,38 @@ + + +# QuantIdentifierUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | +**identifiers** | **java.util.List<String>** | | +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: UniverseTypeEnum + +Name | Value +---- | ----- +EQUITY | "Equity" +DEBT | "Debt" + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryStatusRoot.md b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md similarity index 54% rename from auto-generated-sdk/docs/PACommentaryStatusRoot.md rename to auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md index 06b48ebe..11b77d7f 100644 --- a/auto-generated-sdk/docs/PACommentaryStatusRoot.md +++ b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md @@ -1,14 +1,15 @@ -# PACommentaryStatusRoot +# QuantScreeningExpressionObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PACommentaryStatus**](PACommentaryStatus.md) | | -**meta** | **Object** | | [optional] +**expr** | **String** | | +**name** | **String** | | +**dateOffset** | **String** | | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md new file mode 100644 index 00000000..d63e2df6 --- /dev/null +++ b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md @@ -0,0 +1,39 @@ + + +# QuantScreeningExpressionUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universeExpr** | **String** | | +**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | +**securityExpr** | **String** | | [optional] +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: UniverseTypeEnum + +Name | Value +---- | ----- +EQUITY | "Equity" +DEBT | "Debt" + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/PACommentaryParameters.md b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md similarity index 60% rename from auto-generated-sdk/docs/PACommentaryParameters.md rename to auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md index f8de00cd..8a817724 100644 --- a/auto-generated-sdk/docs/PACommentaryParameters.md +++ b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md @@ -1,13 +1,14 @@ -# PACommentaryParameters +# QuantUniversalScreenParameterObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**configurationid** | **String** | Commentary configuration id | [optional] +**referenceName** | **String** | | +**name** | **String** | | ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md new file mode 100644 index 00000000..0b9214c3 --- /dev/null +++ b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md @@ -0,0 +1,28 @@ + + +# QuantUniversalScreenUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**screen** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md index 2560d28e..83983c13 100644 --- a/auto-generated-sdk/docs/SPARDateParameters.md +++ b/auto-generated-sdk/docs/SPARDateParameters.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes **startdate** | **String** | Calculation's start date. | **enddate** | **String** | Calculation's end date. | **frequency** | **String** | Calculation's frequency. | -**useeachportfolioinception** | **Boolean** | Use Each Portfolio Inception | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/Section.md b/auto-generated-sdk/docs/Section.md deleted file mode 100644 index d34f4679..00000000 --- a/auto-generated-sdk/docs/Section.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# Section - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**Metadata**](Metadata.md) | | [optional] -**title** | **String** | Commentary title | [optional] -**content** | **String** | Generated commentary content | [optional] -**subSections** | [**java.util.List<Section>**](Section.md) | Generated commentary subsections | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/SparCalculationsApi.md b/auto-generated-sdk/docs/SparCalculationsApi.md index b529dd54..d5bca889 100644 --- a/auto-generated-sdk/docs/SparCalculationsApi.md +++ b/auto-generated-sdk/docs/SparCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md index 73842a3e..9a45734e 100644 --- a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md +++ b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md @@ -99,7 +99,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | @@ -181,7 +181,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md deleted file mode 100644 index 9d588e13..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md +++ /dev/null @@ -1,95 +0,0 @@ - -# VaultAttributionLoaderApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**vaultAttributionLoader**](VaultAttributionLoaderApi.md#vaultAttributionLoader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader - - - -## vaultAttributionLoader - -> VaultAttributionLoaderResponseRoot vaultAttributionLoader(batchId, file) - -Vault - External Attribution Loader - -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.VaultAttributionLoaderApi; - -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"); - - VaultAttributionLoaderApi apiInstance = new VaultAttributionLoaderApi(defaultClient); - String batchId = "batchId_example"; // String | - File file = new File("/path/to/file"); // File | - try { - VaultAttributionLoaderResponseRoot result = apiInstance.vaultAttributionLoader(batchId, file); - System.out.println(result); - } catch (ApiException e) { - 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()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batchId** | **String**| | - **file** | **File**| | [optional] - -### Return type - -[**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **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.
| -| **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.
| -| **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/VaultAttributionLoaderResponse.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md deleted file mode 100644 index c4889bd9..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# 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 deleted file mode 100644 index 5cc5749f..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# VaultAttributionLoaderResponseRoot - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | -**meta** | **Object** | | [optional] - - -## Implemented Interfaces - -* Serializable - - diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md index 3a7b8620..e6239922 100644 --- a/auto-generated-sdk/docs/VaultCalculationsApi.md +++ b/auto-generated-sdk/docs/VaultCalculationsApi.md @@ -81,7 +81,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 9a1d0dd6..031e51f2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -15,7 +15,6 @@ import java.io.File; import factset.analyticsapi.engines.models.ClientErrorResponse; -import factset.analyticsapi.engines.models.PACommentaryConfigurationSummaryRoot; import factset.analyticsapi.engines.models.VaultConfigurationRoot; import factset.analyticsapi.engines.models.VaultConfigurationSummaryRoot; @@ -48,92 +47,6 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } - /** - * Get PA commentary configurations in a directory - * This endpoint returns all PA commentary configurations in a given directory. - * @param path The directory to get the PA commentary configurations (required) - @return PACommentaryConfigurationSummaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a map of configuration ID to PA commentary configuration * 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 path 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.
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 PACommentaryConfigurationSummaryRoot getPACommentaryConfigurations(String path) throws ApiException { - return getPACommentaryConfigurationsWithHttpInfo(path).getData(); - } - - /** - * Get PA commentary configurations in a directory - * This endpoint returns all PA commentary configurations in a given directory. - * @param path The directory to get the PA commentary configurations (required) - * @return ApiResponse<PACommentaryConfigurationSummaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - -
Status Code Description Response Headers
200 Expected response, returns a map of configuration ID to PA commentary configuration * 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 path 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.
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 getPACommentaryConfigurationsWithHttpInfo(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 getPACommentaryConfigurations"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/commentary/configurations"; - - // 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("", "path", path)); - - - - - 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(){}); - - return apiClient.invokeAPIWithReturnMap("ConfigurationsApi.getPACommentaryConfigurations", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Get Vault configuration by id * This endpoint returns details for a Vault configuration as well as a list of accounts it is used in. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index bea71fc9..6a3564fe 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -110,7 +110,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index 520e4d9f..a0b911c8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -203,7 +203,7 @@ public ApiResponse deleteLinkedPATemplatesWithHttpInfo(String id) throws A final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index e6eb7833..e8e507f4 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -19,10 +19,6 @@ import factset.analyticsapi.engines.models.ClientErrorResponse; import factset.analyticsapi.engines.models.ObjectRoot; import factset.analyticsapi.engines.models.PACalculationParametersRoot; -import factset.analyticsapi.engines.models.PACommentaryGetStatusRoot; -import factset.analyticsapi.engines.models.PACommentaryParametersRoot; -import factset.analyticsapi.engines.models.PACommentaryRoot; -import factset.analyticsapi.engines.models.PACommentaryStatusRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class PaCalculationsApi { @@ -115,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -134,105 +130,6 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } - /** - * Generate PA portfolio commentary by calculation and unit id. - * This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - * @param paCommentaryParametersRoot Request Parameters (optional) - @return (For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response if the commentary generation is completed in a short span, returns 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.
202 Expected response, contains the poll URL in the Location header. * Location - URL to poll for the resulting commentary
* 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.
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. 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.
- */ - public Object generatePAPortfolioCommentary(String id, String unitId, PACommentaryParametersRoot paCommentaryParametersRoot) throws ApiException { - return generatePAPortfolioCommentaryWithHttpInfo(id, unitId, paCommentaryParametersRoot).getData(); - } - - /** - * Generate PA portfolio commentary by calculation and unit id. - * This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - * @param paCommentaryParametersRoot Request Parameters (optional) - * @return ApiResponse<Object>(For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - - - -
Status Code Description Response Headers
201 Expected response if the commentary generation is completed in a short span, returns 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.
202 Expected response, contains the poll URL in the Location header. * Location - URL to poll for the resulting commentary
* 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.
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. 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.
- */ - public ApiResponse generatePAPortfolioCommentaryWithHttpInfo(String id, String unitId, PACommentaryParametersRoot paCommentaryParametersRoot) throws ApiException { - Object localVarPostBody = paCommentaryParametersRoot; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling generatePAPortfolioCommentary"); - } - - // verify the required parameter 'unitId' is set - if (unitId == null) { - throw new ApiException(400, "Missing the required parameter 'unitId' when calling generatePAPortfolioCommentary"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) - .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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 = { - "application/json" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; - - GenericType localVarReturnType = new GenericType() {}; - - Map returnTypeMap = new HashMap(); - returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(202, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.generatePAPortfolioCommentary", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Get all calculations * This endpoints returns all calculation requests. @@ -583,189 +480,6 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String i localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } - /** - * Get PA Portfolio commentary result by calculation and unit id. - * This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - @return PACommentaryRoot - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
200 Expected response once the commentary generation is completed, returns JSON. * 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.
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.
- */ - public PACommentaryRoot getPAPortfolioCommentaryResultById(String id, String unitId) throws ApiException { - return getPAPortfolioCommentaryResultByIdWithHttpInfo(id, unitId).getData(); - } - - /** - * Get PA Portfolio commentary result by calculation and unit id. - * This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - * @return ApiResponse<PACommentaryRoot> - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
200 Expected response once the commentary generation is completed, returns JSON. * 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.
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.
- */ - public ApiResponse getPAPortfolioCommentaryResultByIdWithHttpInfo(String id, String unitId) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getPAPortfolioCommentaryResultById"); - } - - // verify the required parameter 'unitId' is set - if (unitId == null) { - throw new ApiException(400, "Missing the required parameter 'unitId' when calling getPAPortfolioCommentaryResultById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) - .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getPAPortfolioCommentaryResultById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } - /** - * Get PA portfolio commentary status by calculation and unit id. - * This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - @return (For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response once commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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.
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.
- */ - public Object getPAPortfolioCommentaryStatusById(String id, String unitId) throws ApiException { - return getPAPortfolioCommentaryStatusByIdWithHttpInfo(id, unitId).getData(); - } - - /** - * Get PA portfolio commentary status by calculation and unit id. - * This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. - * @param id Successful calculation id (required) - * @param unitId Unit id associated with the successful calculation id (required) - * @return ApiResponse<Object>(For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) - * @throws ApiException if fails to make API call - * @http.response.details - - - - - - - - - -
Status Code Description Response Headers
200 Expected response once commentary 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 commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. * 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.
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.
- */ - public ApiResponse getPAPortfolioCommentaryStatusByIdWithHttpInfo(String id, String unitId) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException(400, "Missing the required parameter 'id' when calling getPAPortfolioCommentaryStatusById"); - } - - // verify the required parameter 'unitId' is set - if (unitId == null) { - throw new ApiException(400, "Missing the required parameter 'unitId' when calling getPAPortfolioCommentaryStatusById"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())) - .replaceAll("\\{" + "unitId" + "\\}", apiClient.escapeString(unitId.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(202, new GenericType(){}); - returnTypeMap.put(400, new GenericType(){}); - - return apiClient.invokeAPIWithReturnMap("PaCalculationsApi.getPAPortfolioCommentaryStatusById", localVarPath, "GET", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } /** * Create and Run PA calculation * This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index c5764174..2c54e566 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -399,9 +399,9 @@ public ApiResponse getCalculationStatusByIdWithHttpInfo(S Status Code Description Response Headers 200 Expected response once calculation is completed, returns result 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.
- 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.
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.
@@ -422,9 +422,9 @@ public File getCalculationUnitResultById(String id, String unitId) throws ApiExc Status Code Description Response Headers 200 Expected response once calculation is completed, returns result 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.
- 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.
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.
@@ -458,7 +458,7 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str final String[] localVarAccepts = { - "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "application/json" + "application/json", "application/x-protobuf", "application/pdf" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -486,18 +486,18 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - @return (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) * @throws ApiException if fails to make API call * @http.response.details + - + - @@ -514,18 +514,18 @@ public Object postAndCalculate(Integer xFactSetApiLongRunningDeadline, String ca * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) * @throws ApiException if fails to make API call * @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.
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.
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.
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.
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.
+ - + - @@ -553,7 +553,7 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR final String[] localVarAccepts = { - "application/json", "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" + "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -567,9 +567,9 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR GenericType localVarReturnType = new GenericType() {}; Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(200, new GenericType(){}); returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); @@ -584,19 +584,19 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - @return (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) * @throws ApiException if fails to make API call * @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.
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.
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.
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.
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.
+ - - - + + @@ -614,19 +614,19 @@ public Object putAndCalculate(String id, Integer xFactSetApiLongRunningDeadline, * @param xFactSetApiLongRunningDeadline Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param pubCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) * @throws ApiException if fails to make API call * @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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
+ - - - + + @@ -660,7 +660,7 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactS final String[] localVarAccepts = { - "application/json", "application/pdf", "application/vnd.openxmlformats-officedocument.presentationml.presentation" + "application/pdf" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -674,9 +674,9 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, Integer xFactS GenericType localVarReturnType = new GenericType() {}; Map returnTypeMap = new HashMap(); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(200, new GenericType(){}); returnTypeMap.put(201, new GenericType(){}); - returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); returnTypeMap.put(409, new GenericType(){}); 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 c36170e6..d96e755c 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 @@ -112,7 +112,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index a4922c8b..2e2f006e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index 8337e54b..280f95c9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -116,7 +116,7 @@ public ApiResponse createTemplatedPACompone final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -203,7 +203,7 @@ public ApiResponse deleteTemplatedPAComponentsWithHttpInfo(String id) thro final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java deleted file mode 100644 index 893e79fa..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java +++ /dev/null @@ -1,140 +0,0 @@ - -package factset.analyticsapi.engines.api; - -import factset.analyticsapi.engines.ApiException; -import factset.analyticsapi.engines.ApiClient; -import factset.analyticsapi.engines.ApiResponse; -import factset.analyticsapi.engines.Configuration; -import factset.analyticsapi.engines.Pair; - -import javax.ws.rs.core.GenericType; - -import java.util.HashMap; -import java.util.Map; - -import java.io.File; - -import factset.analyticsapi.engines.models.ClientErrorResponse; -import java.io.File; -import factset.analyticsapi.engines.models.VaultAttributionLoaderResponseRoot; - -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class VaultAttributionLoaderApi { - private ApiClient apiClient; - public VaultAttributionLoaderApi() { - this(Configuration.getDefaultApiClient()); - } - - public VaultAttributionLoaderApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get the API cilent - * - * @return API client - */ - public ApiClient getApiClient() { - return apiClient; - } - - /** - * Set the API cilent - * - * @param apiClient an instance of API client - */ - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Vault - External Attribution Loader - * This endpoint loads Vault External Attributions. - * @param batchId (required) - * @param file (optional) - @return VaultAttributionLoaderResponseRoot - * @throws ApiException if fails to make API call - * @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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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, 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
- - - - - - - - - -
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.
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.
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 VaultAttributionLoaderResponseRoot vaultAttributionLoader(String batchId, File file) throws ApiException { - return vaultAttributionLoaderWithHttpInfo(batchId, file).getData(); - } - - /** - * Vault - External Attribution Loader - * This endpoint loads Vault External Attributions. - * @param batchId (required) - * @param file (optional) - * @return ApiResponse<VaultAttributionLoaderResponseRoot> - * @throws ApiException if fails to make API call - * @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.
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.
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 vaultAttributionLoaderWithHttpInfo(String batchId, File file) throws ApiException { - Object localVarPostBody = null; - - // verify the required parameter 'batchId' is set - if (batchId == null) { - throw new ApiException(400, "Missing the required parameter 'batchId' when calling vaultAttributionLoader"); - } - - // create path and map variables - String localVarPath = "/analytics/engines/vault/v3/load/{batchId}" - .replaceAll("\\{" + "batchId" + "\\}", apiClient.escapeString(batchId.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(); - - - - - if (file != null) - localVarFormParams.put("file", file); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - - final String[] localVarContentTypes = { - "multipart/form-data" - }; - 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(){}); - - return apiClient.invokeAPIWithReturnMap("VaultAttributionLoaderApi.vaultAttributionLoader", localVarPath, "POST", localVarQueryParams, localVarPostBody, - localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, - localVarAuthNames, returnTypeMap, false); - } -} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index 305e32da..af10462e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -111,7 +111,7 @@ public ApiResponse cancelCalculationByIdWithHttpInfo(String id) throws Api final String[] localVarAccepts = { - "application/json" + "text/plain", "application/json", "text/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java index d8573bf7..6d11e29e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java @@ -30,9 +30,8 @@ /** - * List of the accounts and directories. + * AccountDirectories */ -@ApiModel(description = "List of the accounts and directories.") @JsonPropertyOrder({ AccountDirectories.JSON_PROPERTY_ACCOUNTS, AccountDirectories.JSON_PROPERTY_DIRECTORIES diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java index 45f3410d..6b7dd2ff 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java @@ -31,9 +31,8 @@ /** - * Details of the calculation. + * CalculationStatus */ -@ApiModel(description = "Details of the calculation.") @JsonPropertyOrder({ CalculationStatus.JSON_PROPERTY_CALCULATIONID, CalculationStatus.JSON_PROPERTY_STATUS, diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java index 5b4d1164..0205601d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java @@ -31,9 +31,8 @@ /** - * Meta of calculation units in batch. + * CalculationStatusMeta */ -@ApiModel(description = "Meta of calculation units in batch.") @JsonPropertyOrder({ CalculationStatusMeta.JSON_PROPERTY_UNITS }) @@ -59,11 +58,11 @@ public CalculationStatusMeta putUnitsItem(String key, CalculationUnitStatusMeta } /** - * List of calculation units in batch. + * Meta of calculation units in batch. * @return units **/ @javax.annotation.Nullable - @ApiModelProperty(value = "List of calculation units in batch.") + @ApiModelProperty(value = "Meta of calculation units in batch.") @JsonProperty(JSON_PROPERTY_UNITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java index 9d7a4f6e..82fd76fb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java @@ -31,9 +31,8 @@ /** - * The status of the calculation as per FactSets API standards + * CalculationUnitStatus */ -@ApiModel(description = "The status of the calculation as per FactSets API standards") @JsonPropertyOrder({ CalculationUnitStatus.JSON_PROPERTY_STATUS, CalculationUnitStatus.JSON_PROPERTY_ERRORS, diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java index 1763449b..f3bb9c81 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java @@ -30,9 +30,8 @@ /** - * Meta of the calculation unit. + * CalculationUnitStatusMeta */ -@ApiModel(description = "Meta of the calculation unit.") @JsonPropertyOrder({ CalculationUnitStatusMeta.JSON_PROPERTY_INFO }) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java index 6ff181d1..692addf0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java @@ -30,9 +30,8 @@ /** - * Details of the currency. + * Currency */ -@ApiModel(description = "Details of the currency.") @JsonPropertyOrder({ Currency.JSON_PROPERTY_NAME }) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java deleted file mode 100644 index fdc2c684..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIConvertibleSettings.java +++ /dev/null @@ -1,298 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * FIConvertibleSettings - */ -@JsonPropertyOrder({ - FIConvertibleSettings.JSON_PROPERTY_EQUITY_PRICE, - FIConvertibleSettings.JSON_PROPERTY_EQUITY_INDEX_VOLATILITY, - FIConvertibleSettings.JSON_PROPERTY_EQUITY_DIVIDEND_YIELD, - FIConvertibleSettings.JSON_PROPERTY_VOLATILITY_CAP_METHOD, - FIConvertibleSettings.JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE, - FIConvertibleSettings.JSON_PROPERTY_EQUITY_EXCHANGE_RATE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class FIConvertibleSettings implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_EQUITY_PRICE = "equityPrice"; - private Double equityPrice; - - public static final String JSON_PROPERTY_EQUITY_INDEX_VOLATILITY = "equityIndexVolatility"; - private Double equityIndexVolatility; - - public static final String JSON_PROPERTY_EQUITY_DIVIDEND_YIELD = "equityDividendYield"; - private Double equityDividendYield; - - /** - * Volatility CapMethod - */ - public enum VolatilityCapMethodEnum { - NOCAP("noCap"), - - SPECIFIEDRATE("specifiedRate"), - - MULTIPLIER("multiplier"); - - private String value; - - VolatilityCapMethodEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static VolatilityCapMethodEnum fromValue(String value) { - for (VolatilityCapMethodEnum b : VolatilityCapMethodEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_VOLATILITY_CAP_METHOD = "volatilityCapMethod"; - private VolatilityCapMethodEnum volatilityCapMethod; - - public static final String JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE = "volatilityCapMethodValue"; - private Double volatilityCapMethodValue; - - public static final String JSON_PROPERTY_EQUITY_EXCHANGE_RATE = "equityExchangeRate"; - private Double equityExchangeRate; - - - public FIConvertibleSettings equityPrice(Double equityPrice) { - this.equityPrice = equityPrice; - return this; - } - - /** - * Equity Price - * @return equityPrice - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Equity Price") - @JsonProperty(JSON_PROPERTY_EQUITY_PRICE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Double getEquityPrice() { - return equityPrice; - } - - - public void setEquityPrice(Double equityPrice) { - this.equityPrice = equityPrice; - } - - - public FIConvertibleSettings equityIndexVolatility(Double equityIndexVolatility) { - this.equityIndexVolatility = equityIndexVolatility; - return this; - } - - /** - * Equity Index Volatility - * @return equityIndexVolatility - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Equity Index Volatility") - @JsonProperty(JSON_PROPERTY_EQUITY_INDEX_VOLATILITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Double getEquityIndexVolatility() { - return equityIndexVolatility; - } - - - public void setEquityIndexVolatility(Double equityIndexVolatility) { - this.equityIndexVolatility = equityIndexVolatility; - } - - - public FIConvertibleSettings equityDividendYield(Double equityDividendYield) { - this.equityDividendYield = equityDividendYield; - return this; - } - - /** - * Equity Dividend Yield - * @return equityDividendYield - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Equity Dividend Yield") - @JsonProperty(JSON_PROPERTY_EQUITY_DIVIDEND_YIELD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Double getEquityDividendYield() { - return equityDividendYield; - } - - - public void setEquityDividendYield(Double equityDividendYield) { - this.equityDividendYield = equityDividendYield; - } - - - public FIConvertibleSettings volatilityCapMethod(VolatilityCapMethodEnum volatilityCapMethod) { - this.volatilityCapMethod = volatilityCapMethod; - return this; - } - - /** - * Volatility CapMethod - * @return volatilityCapMethod - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Volatility CapMethod") - @JsonProperty(JSON_PROPERTY_VOLATILITY_CAP_METHOD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public VolatilityCapMethodEnum getVolatilityCapMethod() { - return volatilityCapMethod; - } - - - public void setVolatilityCapMethod(VolatilityCapMethodEnum volatilityCapMethod) { - this.volatilityCapMethod = volatilityCapMethod; - } - - - public FIConvertibleSettings volatilityCapMethodValue(Double volatilityCapMethodValue) { - this.volatilityCapMethodValue = volatilityCapMethodValue; - return this; - } - - /** - * Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) - * @return volatilityCapMethodValue - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier)") - @JsonProperty(JSON_PROPERTY_VOLATILITY_CAP_METHOD_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Double getVolatilityCapMethodValue() { - return volatilityCapMethodValue; - } - - - public void setVolatilityCapMethodValue(Double volatilityCapMethodValue) { - this.volatilityCapMethodValue = volatilityCapMethodValue; - } - - - public FIConvertibleSettings equityExchangeRate(Double equityExchangeRate) { - this.equityExchangeRate = equityExchangeRate; - return this; - } - - /** - * Equity Exchange Rate - * @return equityExchangeRate - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Equity Exchange Rate") - @JsonProperty(JSON_PROPERTY_EQUITY_EXCHANGE_RATE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Double getEquityExchangeRate() { - return equityExchangeRate; - } - - - public void setEquityExchangeRate(Double equityExchangeRate) { - this.equityExchangeRate = equityExchangeRate; - } - - - /** - * Return true if this FIConvertibleSettings object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - FIConvertibleSettings fiConvertibleSettings = (FIConvertibleSettings) o; - return Objects.equals(this.equityPrice, fiConvertibleSettings.equityPrice) && - Objects.equals(this.equityIndexVolatility, fiConvertibleSettings.equityIndexVolatility) && - Objects.equals(this.equityDividendYield, fiConvertibleSettings.equityDividendYield) && - Objects.equals(this.volatilityCapMethod, fiConvertibleSettings.volatilityCapMethod) && - Objects.equals(this.volatilityCapMethodValue, fiConvertibleSettings.volatilityCapMethodValue) && - Objects.equals(this.equityExchangeRate, fiConvertibleSettings.equityExchangeRate); - } - - @Override - public int hashCode() { - return Objects.hash(equityPrice, equityIndexVolatility, equityDividendYield, volatilityCapMethod, volatilityCapMethodValue, equityExchangeRate); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class FIConvertibleSettings {\n"); - sb.append(" equityPrice: ").append(toIndentedString(equityPrice)).append("\n"); - sb.append(" equityIndexVolatility: ").append(toIndentedString(equityIndexVolatility)).append("\n"); - sb.append(" equityDividendYield: ").append(toIndentedString(equityDividendYield)).append("\n"); - sb.append(" volatilityCapMethod: ").append(toIndentedString(volatilityCapMethod)).append("\n"); - sb.append(" volatilityCapMethodValue: ").append(toIndentedString(volatilityCapMethodValue)).append("\n"); - sb.append(" equityExchangeRate: ").append(toIndentedString(equityExchangeRate)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java index 4f67fb66..a78bfe03 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java @@ -24,7 +24,6 @@ import com.fasterxml.jackson.annotation.JsonValue; import factset.analyticsapi.engines.models.FIAttributionForSecurities; import factset.analyticsapi.engines.models.FIBankLoans; -import factset.analyticsapi.engines.models.FIConvertibleSettings; import factset.analyticsapi.engines.models.FILoss; import factset.analyticsapi.engines.models.FIMunicipalBonds; import factset.analyticsapi.engines.models.FIPrepay; @@ -52,7 +51,6 @@ FISecurity.JSON_PROPERTY_MATRIX_MULTIPLIER, FISecurity.JSON_PROPERTY_STRUCTURED_PRODUCTS, FISecurity.JSON_PROPERTY_ATTRIBUTION, - FISecurity.JSON_PROPERTY_CONVERTIBLE, FISecurity.JSON_PROPERTY_CALC_FROM_METHOD, FISecurity.JSON_PROPERTY_CALC_FROM_VALUE, FISecurity.JSON_PROPERTY_FACE, @@ -136,9 +134,6 @@ public static CallMethodEnum fromValue(String value) { public static final String JSON_PROPERTY_ATTRIBUTION = "attribution"; private FIAttributionForSecurities attribution; - public static final String JSON_PROPERTY_CONVERTIBLE = "convertible"; - private FIConvertibleSettings convertible; - public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; private String calcFromMethod; @@ -457,30 +452,6 @@ public void setAttribution(FIAttributionForSecurities attribution) { } - public FISecurity convertible(FIConvertibleSettings convertible) { - this.convertible = convertible; - return this; - } - - /** - * Get convertible - * @return convertible - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_CONVERTIBLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public FIConvertibleSettings getConvertible() { - return convertible; - } - - - public void setConvertible(FIConvertibleSettings convertible) { - this.convertible = convertible; - } - - public FISecurity calcFromMethod(String calcFromMethod) { this.calcFromMethod = calcFromMethod; return this; @@ -646,7 +617,6 @@ public boolean equals(Object o) { Objects.equals(this.matrixMultiplier, fiSecurity.matrixMultiplier) && Objects.equals(this.structuredProducts, fiSecurity.structuredProducts) && Objects.equals(this.attribution, fiSecurity.attribution) && - Objects.equals(this.convertible, fiSecurity.convertible) && Objects.equals(this.calcFromMethod, fiSecurity.calcFromMethod) && Objects.equals(this.calcFromValue, fiSecurity.calcFromValue) && Objects.equals(this.face, fiSecurity.face) && @@ -657,7 +627,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(settlement, callMethod, referenceSecurity, bankLoans, municipalBonds, loss, prepay, matrixSpreadAdjustment, matrixMultiplier, structuredProducts, attribution, convertible, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); + return Objects.hash(settlement, callMethod, referenceSecurity, bankLoans, municipalBonds, loss, prepay, matrixSpreadAdjustment, matrixMultiplier, structuredProducts, attribution, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); } @Override @@ -675,7 +645,6 @@ public String toString() { sb.append(" matrixMultiplier: ").append(toIndentedString(matrixMultiplier)).append("\n"); sb.append(" structuredProducts: ").append(toIndentedString(structuredProducts)).append("\n"); sb.append(" attribution: ").append(toIndentedString(attribution)).append("\n"); - sb.append(" convertible: ").append(toIndentedString(convertible)).append("\n"); sb.append(" calcFromMethod: ").append(toIndentedString(calcFromMethod)).append("\n"); sb.append(" calcFromValue: ").append(toIndentedString(calcFromValue)).append("\n"); sb.append(" face: ").append(toIndentedString(face)).append("\n"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java deleted file mode 100644 index d6521e0c..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Metadata.java +++ /dev/null @@ -1,262 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentaryDate; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * Metadata - */ -@JsonPropertyOrder({ - Metadata.JSON_PROPERTY_TILE_NAME, - Metadata.JSON_PROPERTY_PORTFOLIO_DESCRIPTION, - Metadata.JSON_PROPERTY_BENCHMARK_DESCRIPTION, - Metadata.JSON_PROPERTY_START_DATE, - Metadata.JSON_PROPERTY_END_DATE, - Metadata.JSON_PROPERTY_FREQUENCY -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class Metadata implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_TILE_NAME = "tileName"; - private String tileName; - - public static final String JSON_PROPERTY_PORTFOLIO_DESCRIPTION = "portfolioDescription"; - private String portfolioDescription; - - public static final String JSON_PROPERTY_BENCHMARK_DESCRIPTION = "benchmarkDescription"; - private String benchmarkDescription; - - public static final String JSON_PROPERTY_START_DATE = "startDate"; - private PACommentaryDate startDate; - - public static final String JSON_PROPERTY_END_DATE = "endDate"; - private PACommentaryDate endDate; - - public static final String JSON_PROPERTY_FREQUENCY = "frequency"; - private String frequency; - - - public Metadata tileName(String tileName) { - this.tileName = tileName; - return this; - } - - /** - * PA Tile name associated with the component - * @return tileName - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA Tile name associated with the component") - @JsonProperty(JSON_PROPERTY_TILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTileName() { - return tileName; - } - - - public void setTileName(String tileName) { - this.tileName = tileName; - } - - - public Metadata portfolioDescription(String portfolioDescription) { - this.portfolioDescription = portfolioDescription; - return this; - } - - /** - * Portfolio name used in generating commentary - * @return portfolioDescription - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Portfolio name used in generating commentary") - @JsonProperty(JSON_PROPERTY_PORTFOLIO_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPortfolioDescription() { - return portfolioDescription; - } - - - public void setPortfolioDescription(String portfolioDescription) { - this.portfolioDescription = portfolioDescription; - } - - - public Metadata benchmarkDescription(String benchmarkDescription) { - this.benchmarkDescription = benchmarkDescription; - return this; - } - - /** - * Benchmark name used in generating commentary - * @return benchmarkDescription - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Benchmark name used in generating commentary") - @JsonProperty(JSON_PROPERTY_BENCHMARK_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBenchmarkDescription() { - return benchmarkDescription; - } - - - public void setBenchmarkDescription(String benchmarkDescription) { - this.benchmarkDescription = benchmarkDescription; - } - - - public Metadata startDate(PACommentaryDate startDate) { - this.startDate = startDate; - return this; - } - - /** - * Get startDate - * @return startDate - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_START_DATE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACommentaryDate getStartDate() { - return startDate; - } - - - public void setStartDate(PACommentaryDate startDate) { - this.startDate = startDate; - } - - - public Metadata endDate(PACommentaryDate endDate) { - this.endDate = endDate; - return this; - } - - /** - * Get endDate - * @return endDate - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_END_DATE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PACommentaryDate getEndDate() { - return endDate; - } - - - public void setEndDate(PACommentaryDate endDate) { - this.endDate = endDate; - } - - - public Metadata frequency(String frequency) { - this.frequency = frequency; - return this; - } - - /** - * Date frequency - * @return frequency - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date frequency") - @JsonProperty(JSON_PROPERTY_FREQUENCY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getFrequency() { - return frequency; - } - - - public void setFrequency(String frequency) { - this.frequency = frequency; - } - - - /** - * Return true if this Metadata object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Metadata metadata = (Metadata) o; - return Objects.equals(this.tileName, metadata.tileName) && - Objects.equals(this.portfolioDescription, metadata.portfolioDescription) && - Objects.equals(this.benchmarkDescription, metadata.benchmarkDescription) && - Objects.equals(this.startDate, metadata.startDate) && - Objects.equals(this.endDate, metadata.endDate) && - Objects.equals(this.frequency, metadata.frequency); - } - - @Override - public int hashCode() { - return Objects.hash(tileName, portfolioDescription, benchmarkDescription, startDate, endDate, frequency); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Metadata {\n"); - sb.append(" tileName: ").append(toIndentedString(tileName)).append("\n"); - sb.append(" portfolioDescription: ").append(toIndentedString(portfolioDescription)).append("\n"); - sb.append(" benchmarkDescription: ").append(toIndentedString(benchmarkDescription)).append("\n"); - sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); - sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java deleted file mode 100644 index cc53021e..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentary.java +++ /dev/null @@ -1,180 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.Section; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentary - */ -@JsonPropertyOrder({ - PACommentary.JSON_PROPERTY_COMMENTARY_ID, - PACommentary.JSON_PROPERTY_SECTIONS, - PACommentary.JSON_PROPERTY_DISCLAIMER -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentary implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_COMMENTARY_ID = "commentaryId"; - private String commentaryId; - - public static final String JSON_PROPERTY_SECTIONS = "sections"; - private java.util.List
sections = null; - - public static final String JSON_PROPERTY_DISCLAIMER = "disclaimer"; - private String disclaimer; - - - public PACommentary commentaryId(String commentaryId) { - this.commentaryId = commentaryId; - return this; - } - - /** - * Generated commentary Id - * @return commentaryId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Generated commentary Id") - @JsonProperty(JSON_PROPERTY_COMMENTARY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCommentaryId() { - return commentaryId; - } - - - public void setCommentaryId(String commentaryId) { - this.commentaryId = commentaryId; - } - - - public PACommentary sections(java.util.List
sections) { - this.sections = sections; - return this; - } - - public PACommentary addSectionsItem(Section sectionsItem) { - if (this.sections == null) { - this.sections = new java.util.ArrayList
(); - } - this.sections.add(sectionsItem); - return this; - } - - /** - * Commentary sections - * @return sections - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Commentary sections") - @JsonProperty(JSON_PROPERTY_SECTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List
getSections() { - return sections; - } - - - public void setSections(java.util.List
sections) { - this.sections = sections; - } - - - public PACommentary disclaimer(String disclaimer) { - this.disclaimer = disclaimer; - return this; - } - - /** - * Disclaimer - * @return disclaimer - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Disclaimer") - @JsonProperty(JSON_PROPERTY_DISCLAIMER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDisclaimer() { - return disclaimer; - } - - - public void setDisclaimer(String disclaimer) { - this.disclaimer = disclaimer; - } - - - /** - * Return true if this PACommentary object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentary paCommentary = (PACommentary) o; - return Objects.equals(this.commentaryId, paCommentary.commentaryId) && - Objects.equals(this.sections, paCommentary.sections) && - Objects.equals(this.disclaimer, paCommentary.disclaimer); - } - - @Override - public int hashCode() { - return Objects.hash(commentaryId, sections, disclaimer); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentary {\n"); - sb.append(" commentaryId: ").append(toIndentedString(commentaryId)).append("\n"); - sb.append(" sections: ").append(toIndentedString(sections)).append("\n"); - sb.append(" disclaimer: ").append(toIndentedString(disclaimer)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java deleted file mode 100644 index 594419ee..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummaryRoot.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentaryConfigurationSummary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryConfigurationSummaryRoot - */ -@JsonPropertyOrder({ - PACommentaryConfigurationSummaryRoot.JSON_PROPERTY_DATA, - PACommentaryConfigurationSummaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryConfigurationSummaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private java.util.Map data = new java.util.HashMap(); - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PACommentaryConfigurationSummaryRoot data(java.util.Map data) { - this.data = data; - return this; - } - - public PACommentaryConfigurationSummaryRoot putDataItem(String key, PACommentaryConfigurationSummary dataItem) { - this.data.put(key, dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public java.util.Map getData() { - return data; - } - - - public void setData(java.util.Map data) { - this.data = data; - } - - - public PACommentaryConfigurationSummaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PACommentaryConfigurationSummaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryConfigurationSummaryRoot paCommentaryConfigurationSummaryRoot = (PACommentaryConfigurationSummaryRoot) o; - return Objects.equals(this.data, paCommentaryConfigurationSummaryRoot.data) && - Objects.equals(this.meta, paCommentaryConfigurationSummaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryConfigurationSummaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java deleted file mode 100644 index cb8320d2..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryDate.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryDate - */ -@JsonPropertyOrder({ - PACommentaryDate.JSON_PROPERTY_YYYYMMDD, - PACommentaryDate.JSON_PROPERTY_RELATIVE -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryDate implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_YYYYMMDD = "yyyymmdd"; - private Integer yyyymmdd; - - public static final String JSON_PROPERTY_RELATIVE = "relative"; - private String relative; - - - public PACommentaryDate yyyymmdd(Integer yyyymmdd) { - this.yyyymmdd = yyyymmdd; - return this; - } - - /** - * Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. - * @return yyyymmdd - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time.") - @JsonProperty(JSON_PROPERTY_YYYYMMDD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getYyyymmdd() { - return yyyymmdd; - } - - - public void setYyyymmdd(Integer yyyymmdd) { - this.yyyymmdd = yyyymmdd; - } - - - public PACommentaryDate relative(String relative) { - this.relative = relative; - return this; - } - - /** - * Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. - * @return relative - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time.") - @JsonProperty(JSON_PROPERTY_RELATIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRelative() { - return relative; - } - - - public void setRelative(String relative) { - this.relative = relative; - } - - - /** - * Return true if this PACommentaryDate object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryDate paCommentaryDate = (PACommentaryDate) o; - return Objects.equals(this.yyyymmdd, paCommentaryDate.yyyymmdd) && - Objects.equals(this.relative, paCommentaryDate.relative); - } - - @Override - public int hashCode() { - return Objects.hash(yyyymmdd, relative); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryDate {\n"); - sb.append(" yyyymmdd: ").append(toIndentedString(yyyymmdd)).append("\n"); - sb.append(" relative: ").append(toIndentedString(relative)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java deleted file mode 100644 index acdc2fa6..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatus.java +++ /dev/null @@ -1,206 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryGetStatus - */ -@JsonPropertyOrder({ - PACommentaryGetStatus.JSON_PROPERTY_CALCULATIONID, - PACommentaryGetStatus.JSON_PROPERTY_UNITID, - PACommentaryGetStatus.JSON_PROPERTY_STATUS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryGetStatus implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_CALCULATIONID = "calculationid"; - private String calculationid; - - public static final String JSON_PROPERTY_UNITID = "unitid"; - private String unitid; - - /** - * The status of commentary generation. - */ - public enum StatusEnum { - EXECUTING("Executing"), - - SUCCESS("Success"); - - private String value; - - StatusEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static StatusEnum fromValue(String value) { - for (StatusEnum b : StatusEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_STATUS = "status"; - private StatusEnum status; - - - public PACommentaryGetStatus calculationid(String calculationid) { - this.calculationid = calculationid; - return this; - } - - /** - * Calculation id. - * @return calculationid - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Calculation id.") - @JsonProperty(JSON_PROPERTY_CALCULATIONID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCalculationid() { - return calculationid; - } - - - public void setCalculationid(String calculationid) { - this.calculationid = calculationid; - } - - - public PACommentaryGetStatus unitid(String unitid) { - this.unitid = unitid; - return this; - } - - /** - * Calculation unit id. - * @return unitid - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Calculation unit id.") - @JsonProperty(JSON_PROPERTY_UNITID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUnitid() { - return unitid; - } - - - public void setUnitid(String unitid) { - this.unitid = unitid; - } - - - public PACommentaryGetStatus status(StatusEnum status) { - this.status = status; - return this; - } - - /** - * The status of commentary generation. - * @return status - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The status of commentary generation.") - @JsonProperty(JSON_PROPERTY_STATUS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public StatusEnum getStatus() { - return status; - } - - - public void setStatus(StatusEnum status) { - this.status = status; - } - - - /** - * Return true if this PACommentaryGetStatus object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryGetStatus paCommentaryGetStatus = (PACommentaryGetStatus) o; - return Objects.equals(this.calculationid, paCommentaryGetStatus.calculationid) && - Objects.equals(this.unitid, paCommentaryGetStatus.unitid) && - Objects.equals(this.status, paCommentaryGetStatus.status); - } - - @Override - public int hashCode() { - return Objects.hash(calculationid, unitid, status); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryGetStatus {\n"); - sb.append(" calculationid: ").append(toIndentedString(calculationid)).append("\n"); - sb.append(" unitid: ").append(toIndentedString(unitid)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java deleted file mode 100644 index 595b259b..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryGetStatusRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentaryGetStatus; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryGetStatusRoot - */ -@JsonPropertyOrder({ - PACommentaryGetStatusRoot.JSON_PROPERTY_DATA, - PACommentaryGetStatusRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryGetStatusRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private PACommentaryGetStatus data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PACommentaryGetStatusRoot data(PACommentaryGetStatus data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PACommentaryGetStatus getData() { - return data; - } - - - public void setData(PACommentaryGetStatus data) { - this.data = data; - } - - - public PACommentaryGetStatusRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PACommentaryGetStatusRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryGetStatusRoot paCommentaryGetStatusRoot = (PACommentaryGetStatusRoot) o; - return Objects.equals(this.data, paCommentaryGetStatusRoot.data) && - Objects.equals(this.meta, paCommentaryGetStatusRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryGetStatusRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java deleted file mode 100644 index 093f8792..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParameters.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryParameters - */ -@JsonPropertyOrder({ - PACommentaryParameters.JSON_PROPERTY_CONFIGURATIONID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryParameters implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_CONFIGURATIONID = "configurationid"; - private String configurationid; - - - public PACommentaryParameters configurationid(String configurationid) { - this.configurationid = configurationid; - return this; - } - - /** - * Commentary configuration id - * @return configurationid - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Commentary configuration id") - @JsonProperty(JSON_PROPERTY_CONFIGURATIONID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getConfigurationid() { - return configurationid; - } - - - public void setConfigurationid(String configurationid) { - this.configurationid = configurationid; - } - - - /** - * Return true if this PACommentaryParameters object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryParameters paCommentaryParameters = (PACommentaryParameters) o; - return Objects.equals(this.configurationid, paCommentaryParameters.configurationid); - } - - @Override - public int hashCode() { - return Objects.hash(configurationid); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryParameters {\n"); - sb.append(" configurationid: ").append(toIndentedString(configurationid)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java deleted file mode 100644 index 5658526f..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryParametersRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentaryParameters; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryParametersRoot - */ -@JsonPropertyOrder({ - PACommentaryParametersRoot.JSON_PROPERTY_DATA, - PACommentaryParametersRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryParametersRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private PACommentaryParameters data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PACommentaryParametersRoot data(PACommentaryParameters data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PACommentaryParameters getData() { - return data; - } - - - public void setData(PACommentaryParameters data) { - this.data = data; - } - - - public PACommentaryParametersRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PACommentaryParametersRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryParametersRoot paCommentaryParametersRoot = (PACommentaryParametersRoot) o; - return Objects.equals(this.data, paCommentaryParametersRoot.data) && - Objects.equals(this.meta, paCommentaryParametersRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryParametersRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java deleted file mode 100644 index 0bf8a87a..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentary; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryRoot - */ -@JsonPropertyOrder({ - PACommentaryRoot.JSON_PROPERTY_DATA, - PACommentaryRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private PACommentary data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PACommentaryRoot data(PACommentary data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PACommentary getData() { - return data; - } - - - public void setData(PACommentary data) { - this.data = data; - } - - - public PACommentaryRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PACommentaryRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryRoot paCommentaryRoot = (PACommentaryRoot) o; - return Objects.equals(this.data, paCommentaryRoot.data) && - Objects.equals(this.meta, paCommentaryRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java deleted file mode 100644 index 6a0daae9..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatus.java +++ /dev/null @@ -1,236 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryStatus - */ -@JsonPropertyOrder({ - PACommentaryStatus.JSON_PROPERTY_RESULT, - PACommentaryStatus.JSON_PROPERTY_CALCULATIONID, - PACommentaryStatus.JSON_PROPERTY_UNITID, - PACommentaryStatus.JSON_PROPERTY_STATUS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryStatus implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_RESULT = "result"; - private String result; - - public static final String JSON_PROPERTY_CALCULATIONID = "calculationid"; - private String calculationid; - - public static final String JSON_PROPERTY_UNITID = "unitid"; - private String unitid; - - /** - * The status of commentary generation. - */ - public enum StatusEnum { - EXECUTING("Executing"), - - SUCCESS("Success"); - - private String value; - - StatusEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static StatusEnum fromValue(String value) { - for (StatusEnum b : StatusEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_STATUS = "status"; - private StatusEnum status; - - - public PACommentaryStatus result(String result) { - this.result = result; - return this; - } - - /** - * The result url of the generated commentary. - * @return result - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The result url of the generated commentary.") - @JsonProperty(JSON_PROPERTY_RESULT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResult() { - return result; - } - - - public void setResult(String result) { - this.result = result; - } - - - public PACommentaryStatus calculationid(String calculationid) { - this.calculationid = calculationid; - return this; - } - - /** - * Calculation id. - * @return calculationid - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Calculation id.") - @JsonProperty(JSON_PROPERTY_CALCULATIONID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCalculationid() { - return calculationid; - } - - - public void setCalculationid(String calculationid) { - this.calculationid = calculationid; - } - - - public PACommentaryStatus unitid(String unitid) { - this.unitid = unitid; - return this; - } - - /** - * Calculation unit id. - * @return unitid - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Calculation unit id.") - @JsonProperty(JSON_PROPERTY_UNITID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUnitid() { - return unitid; - } - - - public void setUnitid(String unitid) { - this.unitid = unitid; - } - - - public PACommentaryStatus status(StatusEnum status) { - this.status = status; - return this; - } - - /** - * The status of commentary generation. - * @return status - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The status of commentary generation.") - @JsonProperty(JSON_PROPERTY_STATUS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public StatusEnum getStatus() { - return status; - } - - - public void setStatus(StatusEnum status) { - this.status = status; - } - - - /** - * Return true if this PACommentaryStatus object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryStatus paCommentaryStatus = (PACommentaryStatus) o; - return Objects.equals(this.result, paCommentaryStatus.result) && - Objects.equals(this.calculationid, paCommentaryStatus.calculationid) && - Objects.equals(this.unitid, paCommentaryStatus.unitid) && - Objects.equals(this.status, paCommentaryStatus.status); - } - - @Override - public int hashCode() { - return Objects.hash(result, calculationid, unitid, status); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryStatus {\n"); - sb.append(" result: ").append(toIndentedString(result)).append("\n"); - sb.append(" calculationid: ").append(toIndentedString(calculationid)).append("\n"); - sb.append(" unitid: ").append(toIndentedString(unitid)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java deleted file mode 100644 index ea93fc1a..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryStatusRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.PACommentaryStatus; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * PACommentaryStatusRoot - */ -@JsonPropertyOrder({ - PACommentaryStatusRoot.JSON_PROPERTY_DATA, - PACommentaryStatusRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryStatusRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private PACommentaryStatus data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public PACommentaryStatusRoot data(PACommentaryStatus data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public PACommentaryStatus getData() { - return data; - } - - - public void setData(PACommentaryStatus data) { - this.data = data; - } - - - public PACommentaryStatusRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this PACommentaryStatusRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PACommentaryStatusRoot paCommentaryStatusRoot = (PACommentaryStatusRoot) o; - return Objects.equals(this.data, paCommentaryStatusRoot.data) && - Objects.equals(this.meta, paCommentaryStatusRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryStatusRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java new file mode 100644 index 00000000..a3e54271 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java @@ -0,0 +1,207 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantDateListObsolete + */ +@JsonPropertyOrder({ + QuantDateListObsolete.JSON_PROPERTY_DATES, + QuantDateListObsolete.JSON_PROPERTY_FREQUENCY, + QuantDateListObsolete.JSON_PROPERTY_CALENDAR, + QuantDateListObsolete.JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantDateListObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATES = "dates"; + private java.util.List dates = null; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + public static final String JSON_PROPERTY_CALENDAR = "calendar"; + private String calendar; + + public static final String JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR = "overrideUniversalScreenCalendar"; + private Boolean overrideUniversalScreenCalendar; + + + public QuantDateListObsolete dates(java.util.List dates) { + this.dates = dates; + return this; + } + + public QuantDateListObsolete addDatesItem(String datesItem) { + if (this.dates == null) { + this.dates = new java.util.ArrayList(); + } + this.dates.add(datesItem); + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getDates() { + return dates; + } + + + public void setDates(java.util.List dates) { + this.dates = dates; + } + + + public QuantDateListObsolete frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Get frequency + * @return frequency + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + public QuantDateListObsolete calendar(String calendar) { + this.calendar = calendar; + return this; + } + + /** + * Get calendar + * @return calendar + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getCalendar() { + return calendar; + } + + + public void setCalendar(String calendar) { + this.calendar = calendar; + } + + + public QuantDateListObsolete overrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { + this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; + return this; + } + + /** + * Get overrideUniversalScreenCalendar + * @return overrideUniversalScreenCalendar + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getOverrideUniversalScreenCalendar() { + return overrideUniversalScreenCalendar; + } + + + public void setOverrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { + this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; + } + + + /** + * Return true if this QuantDateListObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantDateListObsolete quantDateListObsolete = (QuantDateListObsolete) o; + return Objects.equals(this.dates, quantDateListObsolete.dates) && + Objects.equals(this.frequency, quantDateListObsolete.frequency) && + Objects.equals(this.calendar, quantDateListObsolete.calendar) && + Objects.equals(this.overrideUniversalScreenCalendar, quantDateListObsolete.overrideUniversalScreenCalendar); + } + + @Override + public int hashCode() { + return Objects.hash(dates, frequency, calendar, overrideUniversalScreenCalendar); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantDateListObsolete {\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); + sb.append(" overrideUniversalScreenCalendar: ").append(toIndentedString(overrideUniversalScreenCalendar)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java new file mode 100644 index 00000000..bc33f79b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java @@ -0,0 +1,227 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantFdsDateObsolete + */ +@JsonPropertyOrder({ + QuantFdsDateObsolete.JSON_PROPERTY_START_DATE, + QuantFdsDateObsolete.JSON_PROPERTY_END_DATE, + QuantFdsDateObsolete.JSON_PROPERTY_FREQUENCY, + QuantFdsDateObsolete.JSON_PROPERTY_CALENDAR, + QuantFdsDateObsolete.JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantFdsDateObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_START_DATE = "startDate"; + private String startDate; + + public static final String JSON_PROPERTY_END_DATE = "endDate"; + private String endDate; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + public static final String JSON_PROPERTY_CALENDAR = "calendar"; + private String calendar; + + public static final String JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR = "overrideUniversalScreenCalendar"; + private Boolean overrideUniversalScreenCalendar; + + + public QuantFdsDateObsolete startDate(String startDate) { + this.startDate = startDate; + return this; + } + + /** + * Get startDate + * @return startDate + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getStartDate() { + return startDate; + } + + + public void setStartDate(String startDate) { + this.startDate = startDate; + } + + + public QuantFdsDateObsolete endDate(String endDate) { + this.endDate = endDate; + return this; + } + + /** + * Get endDate + * @return endDate + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getEndDate() { + return endDate; + } + + + public void setEndDate(String endDate) { + this.endDate = endDate; + } + + + public QuantFdsDateObsolete frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Get frequency + * @return frequency + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + public QuantFdsDateObsolete calendar(String calendar) { + this.calendar = calendar; + return this; + } + + /** + * Get calendar + * @return calendar + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getCalendar() { + return calendar; + } + + + public void setCalendar(String calendar) { + this.calendar = calendar; + } + + + public QuantFdsDateObsolete overrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { + this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; + return this; + } + + /** + * Get overrideUniversalScreenCalendar + * @return overrideUniversalScreenCalendar + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OVERRIDE_UNIVERSAL_SCREEN_CALENDAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getOverrideUniversalScreenCalendar() { + return overrideUniversalScreenCalendar; + } + + + public void setOverrideUniversalScreenCalendar(Boolean overrideUniversalScreenCalendar) { + this.overrideUniversalScreenCalendar = overrideUniversalScreenCalendar; + } + + + /** + * Return true if this QuantFdsDateObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantFdsDateObsolete quantFdsDateObsolete = (QuantFdsDateObsolete) o; + return Objects.equals(this.startDate, quantFdsDateObsolete.startDate) && + Objects.equals(this.endDate, quantFdsDateObsolete.endDate) && + Objects.equals(this.frequency, quantFdsDateObsolete.frequency) && + Objects.equals(this.calendar, quantFdsDateObsolete.calendar) && + Objects.equals(this.overrideUniversalScreenCalendar, quantFdsDateObsolete.overrideUniversalScreenCalendar); + } + + @Override + public int hashCode() { + return Objects.hash(startDate, endDate, frequency, calendar, overrideUniversalScreenCalendar); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantFdsDateObsolete {\n"); + sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); + sb.append(" overrideUniversalScreenCalendar: ").append(toIndentedString(overrideUniversalScreenCalendar)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java new file mode 100644 index 00000000..78e8603a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java @@ -0,0 +1,199 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantFqlExpressionObsolete + */ +@JsonPropertyOrder({ + QuantFqlExpressionObsolete.JSON_PROPERTY_EXPR, + QuantFqlExpressionObsolete.JSON_PROPERTY_NAME, + QuantFqlExpressionObsolete.JSON_PROPERTY_DATE_OFFSET, + QuantFqlExpressionObsolete.JSON_PROPERTY_IS_ARRAY_RETURN_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantFqlExpressionObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_EXPR = "expr"; + private String expr; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DATE_OFFSET = "dateOffset"; + private String dateOffset; + + public static final String JSON_PROPERTY_IS_ARRAY_RETURN_TYPE = "isArrayReturnType"; + private Boolean isArrayReturnType; + + + public QuantFqlExpressionObsolete expr(String expr) { + this.expr = expr; + return this; + } + + /** + * Get expr + * @return expr + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getExpr() { + return expr; + } + + + public void setExpr(String expr) { + this.expr = expr; + } + + + public QuantFqlExpressionObsolete name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public QuantFqlExpressionObsolete dateOffset(String dateOffset) { + this.dateOffset = dateOffset; + return this; + } + + /** + * Get dateOffset + * @return dateOffset + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATE_OFFSET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDateOffset() { + return dateOffset; + } + + + public void setDateOffset(String dateOffset) { + this.dateOffset = dateOffset; + } + + + public QuantFqlExpressionObsolete isArrayReturnType(Boolean isArrayReturnType) { + this.isArrayReturnType = isArrayReturnType; + return this; + } + + /** + * Get isArrayReturnType + * @return isArrayReturnType + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_IS_ARRAY_RETURN_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsArrayReturnType() { + return isArrayReturnType; + } + + + public void setIsArrayReturnType(Boolean isArrayReturnType) { + this.isArrayReturnType = isArrayReturnType; + } + + + /** + * Return true if this QuantFqlExpressionObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantFqlExpressionObsolete quantFqlExpressionObsolete = (QuantFqlExpressionObsolete) o; + return Objects.equals(this.expr, quantFqlExpressionObsolete.expr) && + Objects.equals(this.name, quantFqlExpressionObsolete.name) && + Objects.equals(this.dateOffset, quantFqlExpressionObsolete.dateOffset) && + Objects.equals(this.isArrayReturnType, quantFqlExpressionObsolete.isArrayReturnType); + } + + @Override + public int hashCode() { + return Objects.hash(expr, name, dateOffset, isArrayReturnType); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantFqlExpressionObsolete {\n"); + sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" dateOffset: ").append(toIndentedString(dateOffset)).append("\n"); + sb.append(" isArrayReturnType: ").append(toIndentedString(isArrayReturnType)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java new file mode 100644 index 00000000..dec5f67b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java @@ -0,0 +1,246 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantIdentifierUniverseObsolete + */ +@JsonPropertyOrder({ + QuantIdentifierUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, + QuantIdentifierUniverseObsolete.JSON_PROPERTY_IDENTIFIERS, + QuantIdentifierUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantIdentifierUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets universeType + */ + public enum UniverseTypeEnum { + EQUITY("Equity"), + + DEBT("Debt"); + + private String value; + + UniverseTypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static UniverseTypeEnum fromValue(String value) { + for (UniverseTypeEnum b : UniverseTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; + private UniverseTypeEnum universeType; + + public static final String JSON_PROPERTY_IDENTIFIERS = "identifiers"; + private java.util.List identifiers = new java.util.ArrayList(); + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + + public QuantIdentifierUniverseObsolete universeType(UniverseTypeEnum universeType) { + this.universeType = universeType; + return this; + } + + /** + * Get universeType + * @return universeType + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UniverseTypeEnum getUniverseType() { + return universeType; + } + + + public void setUniverseType(UniverseTypeEnum universeType) { + this.universeType = universeType; + } + + + public QuantIdentifierUniverseObsolete identifiers(java.util.List identifiers) { + this.identifiers = identifiers; + return this; + } + + public QuantIdentifierUniverseObsolete addIdentifiersItem(String identifiersItem) { + this.identifiers.add(identifiersItem); + return this; + } + + /** + * Get identifiers + * @return identifiers + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_IDENTIFIERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.List getIdentifiers() { + return identifiers; + } + + + public void setIdentifiers(java.util.List identifiers) { + this.identifiers = identifiers; + } + + + public QuantIdentifierUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantIdentifierUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantIdentifierUniverseObsolete quantIdentifierUniverseObsolete = (QuantIdentifierUniverseObsolete) o; + return Objects.equals(this.universeType, quantIdentifierUniverseObsolete.universeType) && + Objects.equals(this.identifiers, quantIdentifierUniverseObsolete.identifiers) && + Objects.equals(this.source, quantIdentifierUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(universeType, identifiers, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantIdentifierUniverseObsolete {\n"); + sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); + sb.append(" identifiers: ").append(toIndentedString(identifiers)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java new file mode 100644 index 00000000..d56aa331 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java @@ -0,0 +1,169 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantScreeningExpressionObsolete + */ +@JsonPropertyOrder({ + QuantScreeningExpressionObsolete.JSON_PROPERTY_EXPR, + QuantScreeningExpressionObsolete.JSON_PROPERTY_NAME, + QuantScreeningExpressionObsolete.JSON_PROPERTY_DATE_OFFSET +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantScreeningExpressionObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_EXPR = "expr"; + private String expr; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_DATE_OFFSET = "dateOffset"; + private String dateOffset; + + + public QuantScreeningExpressionObsolete expr(String expr) { + this.expr = expr; + return this; + } + + /** + * Get expr + * @return expr + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getExpr() { + return expr; + } + + + public void setExpr(String expr) { + this.expr = expr; + } + + + public QuantScreeningExpressionObsolete name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public QuantScreeningExpressionObsolete dateOffset(String dateOffset) { + this.dateOffset = dateOffset; + return this; + } + + /** + * Get dateOffset + * @return dateOffset + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATE_OFFSET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDateOffset() { + return dateOffset; + } + + + public void setDateOffset(String dateOffset) { + this.dateOffset = dateOffset; + } + + + /** + * Return true if this QuantScreeningExpressionObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantScreeningExpressionObsolete quantScreeningExpressionObsolete = (QuantScreeningExpressionObsolete) o; + return Objects.equals(this.expr, quantScreeningExpressionObsolete.expr) && + Objects.equals(this.name, quantScreeningExpressionObsolete.name) && + Objects.equals(this.dateOffset, quantScreeningExpressionObsolete.dateOffset); + } + + @Override + public int hashCode() { + return Objects.hash(expr, name, dateOffset); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantScreeningExpressionObsolete {\n"); + sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" dateOffset: ").append(toIndentedString(dateOffset)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java new file mode 100644 index 00000000..e55c3861 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java @@ -0,0 +1,271 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantScreeningExpressionUniverseObsolete + */ +@JsonPropertyOrder({ + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_EXPR, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SECURITY_EXPR, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantScreeningExpressionUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_UNIVERSE_EXPR = "universeExpr"; + private String universeExpr; + + /** + * Gets or Sets universeType + */ + public enum UniverseTypeEnum { + EQUITY("Equity"), + + DEBT("Debt"); + + private String value; + + UniverseTypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static UniverseTypeEnum fromValue(String value) { + for (UniverseTypeEnum b : UniverseTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; + private UniverseTypeEnum universeType; + + public static final String JSON_PROPERTY_SECURITY_EXPR = "securityExpr"; + private String securityExpr; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + + public QuantScreeningExpressionUniverseObsolete universeExpr(String universeExpr) { + this.universeExpr = universeExpr; + return this; + } + + /** + * Get universeExpr + * @return universeExpr + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getUniverseExpr() { + return universeExpr; + } + + + public void setUniverseExpr(String universeExpr) { + this.universeExpr = universeExpr; + } + + + public QuantScreeningExpressionUniverseObsolete universeType(UniverseTypeEnum universeType) { + this.universeType = universeType; + return this; + } + + /** + * Get universeType + * @return universeType + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UniverseTypeEnum getUniverseType() { + return universeType; + } + + + public void setUniverseType(UniverseTypeEnum universeType) { + this.universeType = universeType; + } + + + public QuantScreeningExpressionUniverseObsolete securityExpr(String securityExpr) { + this.securityExpr = securityExpr; + return this; + } + + /** + * Get securityExpr + * @return securityExpr + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SECURITY_EXPR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecurityExpr() { + return securityExpr; + } + + + public void setSecurityExpr(String securityExpr) { + this.securityExpr = securityExpr; + } + + + public QuantScreeningExpressionUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantScreeningExpressionUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantScreeningExpressionUniverseObsolete quantScreeningExpressionUniverseObsolete = (QuantScreeningExpressionUniverseObsolete) o; + return Objects.equals(this.universeExpr, quantScreeningExpressionUniverseObsolete.universeExpr) && + Objects.equals(this.universeType, quantScreeningExpressionUniverseObsolete.universeType) && + Objects.equals(this.securityExpr, quantScreeningExpressionUniverseObsolete.securityExpr) && + Objects.equals(this.source, quantScreeningExpressionUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(universeExpr, universeType, securityExpr, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantScreeningExpressionUniverseObsolete {\n"); + sb.append(" universeExpr: ").append(toIndentedString(universeExpr)).append("\n"); + sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); + sb.append(" securityExpr: ").append(toIndentedString(securityExpr)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java similarity index 58% rename from auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java rename to auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java index 50c73430..a899276d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACommentaryConfigurationSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java @@ -30,73 +30,71 @@ /** - * PACommentaryConfigurationSummary + * QuantUniversalScreenParameterObsolete */ @JsonPropertyOrder({ - PACommentaryConfigurationSummary.JSON_PROPERTY_NAME, - PACommentaryConfigurationSummary.JSON_PROPERTY_DIRECTORY + QuantUniversalScreenParameterObsolete.JSON_PROPERTY_REFERENCE_NAME, + QuantUniversalScreenParameterObsolete.JSON_PROPERTY_NAME }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class PACommentaryConfigurationSummary implements Serializable { +public class QuantUniversalScreenParameterObsolete implements Serializable { private static final long serialVersionUID = 1L; + public static final String JSON_PROPERTY_REFERENCE_NAME = "referenceName"; + private String referenceName; + public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_DIRECTORY = "directory"; - private String directory; - - public PACommentaryConfigurationSummary name(String name) { - this.name = name; + public QuantUniversalScreenParameterObsolete referenceName(String referenceName) { + this.referenceName = referenceName; return this; } /** - * PA commentary configuration name - * @return name + * Get referenceName + * @return referenceName **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA commentary configuration name") - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getName() { - return name; + public String getReferenceName() { + return referenceName; } - public void setName(String name) { - this.name = name; + public void setReferenceName(String referenceName) { + this.referenceName = referenceName; } - public PACommentaryConfigurationSummary directory(String directory) { - this.directory = directory; + public QuantUniversalScreenParameterObsolete name(String name) { + this.name = name; return this; } /** - * PA Commentary configuration directory - * @return directory + * Get name + * @return name **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "PA Commentary configuration directory") - @JsonProperty(JSON_PROPERTY_DIRECTORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getDirectory() { - return directory; + public String getName() { + return name; } - public void setDirectory(String directory) { - this.directory = directory; + public void setName(String name) { + this.name = name; } /** - * Return true if this PACommentaryConfigurationSummary object is equal to o. + * Return true if this QuantUniversalScreenParameterObsolete object is equal to o. */ @Override public boolean equals(Object o) { @@ -106,22 +104,22 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - PACommentaryConfigurationSummary paCommentaryConfigurationSummary = (PACommentaryConfigurationSummary) o; - return Objects.equals(this.name, paCommentaryConfigurationSummary.name) && - Objects.equals(this.directory, paCommentaryConfigurationSummary.directory); + QuantUniversalScreenParameterObsolete quantUniversalScreenParameterObsolete = (QuantUniversalScreenParameterObsolete) o; + return Objects.equals(this.referenceName, quantUniversalScreenParameterObsolete.referenceName) && + Objects.equals(this.name, quantUniversalScreenParameterObsolete.name); } @Override public int hashCode() { - return Objects.hash(name, directory); + return Objects.hash(referenceName, name); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class PACommentaryConfigurationSummary {\n"); + sb.append("class QuantUniversalScreenParameterObsolete {\n"); + sb.append(" referenceName: ").append(toIndentedString(referenceName)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java new file mode 100644 index 00000000..1d9832b5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java @@ -0,0 +1,177 @@ +/* + * 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] + * Contact: api@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantUniversalScreenUniverseObsolete + */ +@JsonPropertyOrder({ + QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SCREEN, + QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantUniversalScreenUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_SCREEN = "screen"; + private String screen; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + + public QuantUniversalScreenUniverseObsolete screen(String screen) { + this.screen = screen; + return this; + } + + /** + * Get screen + * @return screen + **/ + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SCREEN) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getScreen() { + return screen; + } + + + public void setScreen(String screen) { + this.screen = screen; + } + + + public QuantUniversalScreenUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantUniversalScreenUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantUniversalScreenUniverseObsolete quantUniversalScreenUniverseObsolete = (QuantUniversalScreenUniverseObsolete) o; + return Objects.equals(this.screen, quantUniversalScreenUniverseObsolete.screen) && + Objects.equals(this.source, quantUniversalScreenUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(screen, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantUniversalScreenUniverseObsolete {\n"); + sb.append(" screen: ").append(toIndentedString(screen)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java index 149b7546..3745cbd7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java @@ -36,8 +36,7 @@ @JsonPropertyOrder({ SPARDateParameters.JSON_PROPERTY_STARTDATE, SPARDateParameters.JSON_PROPERTY_ENDDATE, - SPARDateParameters.JSON_PROPERTY_FREQUENCY, - SPARDateParameters.JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION + SPARDateParameters.JSON_PROPERTY_FREQUENCY }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class SPARDateParameters implements Serializable { @@ -52,9 +51,6 @@ public class SPARDateParameters implements Serializable { public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; - public static final String JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION = "useeachportfolioinception"; - private Boolean useeachportfolioinception; - public SPARDateParameters startdate(String startdate) { this.startdate = startdate; @@ -125,30 +121,6 @@ public void setFrequency(String frequency) { } - public SPARDateParameters useeachportfolioinception(Boolean useeachportfolioinception) { - this.useeachportfolioinception = useeachportfolioinception; - return this; - } - - /** - * Use Each Portfolio Inception - * @return useeachportfolioinception - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Use Each Portfolio Inception") - @JsonProperty(JSON_PROPERTY_USEEACHPORTFOLIOINCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getUseeachportfolioinception() { - return useeachportfolioinception; - } - - - public void setUseeachportfolioinception(Boolean useeachportfolioinception) { - this.useeachportfolioinception = useeachportfolioinception; - } - - /** * Return true if this SPARDateParameters object is equal to o. */ @@ -163,13 +135,12 @@ public boolean equals(Object o) { SPARDateParameters spARDateParameters = (SPARDateParameters) o; return Objects.equals(this.startdate, spARDateParameters.startdate) && Objects.equals(this.enddate, spARDateParameters.enddate) && - Objects.equals(this.frequency, spARDateParameters.frequency) && - Objects.equals(this.useeachportfolioinception, spARDateParameters.useeachportfolioinception); + Objects.equals(this.frequency, spARDateParameters.frequency); } @Override public int hashCode() { - return Objects.hash(startdate, enddate, frequency, useeachportfolioinception); + return Objects.hash(startdate, enddate, frequency); } @Override @@ -179,7 +150,6 @@ public String toString() { sb.append(" startdate: ").append(toIndentedString(startdate)).append("\n"); sb.append(" enddate: ").append(toIndentedString(enddate)).append("\n"); sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); - sb.append(" useeachportfolioinception: ").append(toIndentedString(useeachportfolioinception)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java deleted file mode 100644 index e5dc6ef6..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Section.java +++ /dev/null @@ -1,210 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.Metadata; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * Section - */ -@JsonPropertyOrder({ - Section.JSON_PROPERTY_METADATA, - Section.JSON_PROPERTY_TITLE, - Section.JSON_PROPERTY_CONTENT, - Section.JSON_PROPERTY_SUB_SECTIONS -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class Section implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_METADATA = "metadata"; - private Metadata metadata; - - public static final String JSON_PROPERTY_TITLE = "title"; - private String title; - - public static final String JSON_PROPERTY_CONTENT = "content"; - private String content; - - public static final String JSON_PROPERTY_SUB_SECTIONS = "subSections"; - private java.util.List
subSections = null; - - - public Section metadata(Metadata metadata) { - this.metadata = metadata; - return this; - } - - /** - * Get metadata - * @return metadata - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Metadata getMetadata() { - return metadata; - } - - - public void setMetadata(Metadata metadata) { - this.metadata = metadata; - } - - - public Section title(String title) { - this.title = title; - return this; - } - - /** - * Commentary title - * @return title - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Commentary title") - @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTitle() { - return title; - } - - - public void setTitle(String title) { - this.title = title; - } - - - public Section content(String content) { - this.content = content; - return this; - } - - /** - * Generated commentary content - * @return content - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Generated commentary content") - @JsonProperty(JSON_PROPERTY_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getContent() { - return content; - } - - - public void setContent(String content) { - this.content = content; - } - - - public Section subSections(java.util.List
subSections) { - this.subSections = subSections; - return this; - } - - public Section addSubSectionsItem(Section subSectionsItem) { - if (this.subSections == null) { - this.subSections = new java.util.ArrayList
(); - } - this.subSections.add(subSectionsItem); - return this; - } - - /** - * Generated commentary subsections - * @return subSections - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Generated commentary subsections") - @JsonProperty(JSON_PROPERTY_SUB_SECTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List
getSubSections() { - return subSections; - } - - - public void setSubSections(java.util.List
subSections) { - this.subSections = subSections; - } - - - /** - * Return true if this Section object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Section section = (Section) o; - return Objects.equals(this.metadata, section.metadata) && - Objects.equals(this.title, section.title) && - Objects.equals(this.content, section.content) && - Objects.equals(this.subSections, section.subSections); - } - - @Override - public int hashCode() { - return Objects.hash(metadata, title, content, subSections); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Section {\n"); - sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); - sb.append(" title: ").append(toIndentedString(title)).append("\n"); - sb.append(" content: ").append(toIndentedString(content)).append("\n"); - sb.append(" subSections: ").append(toIndentedString(subSections)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java deleted file mode 100644 index 6d7a9982..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * VaultAttributionLoaderResponse - */ -@JsonPropertyOrder({ - VaultAttributionLoaderResponse.JSON_PROPERTY_PROCESS_ID, - VaultAttributionLoaderResponse.JSON_PROPERTY_GROUP_ID, - VaultAttributionLoaderResponse.JSON_PROPERTY_OBJECT_ID -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class VaultAttributionLoaderResponse implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_PROCESS_ID = "processId"; - private String processId; - - public static final String JSON_PROPERTY_GROUP_ID = "groupId"; - private String groupId; - - public static final String JSON_PROPERTY_OBJECT_ID = "objectId"; - private String objectId; - - - public VaultAttributionLoaderResponse processId(String processId) { - this.processId = processId; - return this; - } - - /** - * ProcessId. - * @return processId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "ProcessId.") - @JsonProperty(JSON_PROPERTY_PROCESS_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getProcessId() { - return processId; - } - - - public void setProcessId(String processId) { - this.processId = processId; - } - - - public VaultAttributionLoaderResponse groupId(String groupId) { - this.groupId = groupId; - return this; - } - - /** - * GroupId. - * @return groupId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "GroupId.") - @JsonProperty(JSON_PROPERTY_GROUP_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGroupId() { - return groupId; - } - - - public void setGroupId(String groupId) { - this.groupId = groupId; - } - - - public VaultAttributionLoaderResponse objectId(String objectId) { - this.objectId = objectId; - return this; - } - - /** - * ObjectId. - * @return objectId - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "ObjectId.") - @JsonProperty(JSON_PROPERTY_OBJECT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getObjectId() { - return objectId; - } - - - public void setObjectId(String objectId) { - this.objectId = objectId; - } - - - /** - * Return true if this VaultAttributionLoaderResponse object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VaultAttributionLoaderResponse vaultAttributionLoaderResponse = (VaultAttributionLoaderResponse) o; - return Objects.equals(this.processId, vaultAttributionLoaderResponse.processId) && - Objects.equals(this.groupId, vaultAttributionLoaderResponse.groupId) && - Objects.equals(this.objectId, vaultAttributionLoaderResponse.objectId); - } - - @Override - public int hashCode() { - return Objects.hash(processId, groupId, objectId); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VaultAttributionLoaderResponse {\n"); - sb.append(" processId: ").append(toIndentedString(processId)).append("\n"); - sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); - sb.append(" objectId: ").append(toIndentedString(objectId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java deleted file mode 100644 index d5c0bff0..00000000 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * 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] - * Contact: api@factset.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package factset.analyticsapi.engines.models; - -import java.util.Objects; -import java.util.Arrays; -import java.util.Map; -import java.util.HashMap; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.VaultAttributionLoaderResponse; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.Serializable; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import factset.analyticsapi.engines.JSON; - - -/** - * VaultAttributionLoaderResponseRoot - */ -@JsonPropertyOrder({ - VaultAttributionLoaderResponseRoot.JSON_PROPERTY_DATA, - VaultAttributionLoaderResponseRoot.JSON_PROPERTY_META -}) -@javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class VaultAttributionLoaderResponseRoot implements Serializable { - private static final long serialVersionUID = 1L; - - public static final String JSON_PROPERTY_DATA = "data"; - private VaultAttributionLoaderResponse data; - - public static final String JSON_PROPERTY_META = "meta"; - private Object meta; - - - public VaultAttributionLoaderResponseRoot data(VaultAttributionLoaderResponse data) { - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @ApiModelProperty(required = true, value = "") - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public VaultAttributionLoaderResponse getData() { - return data; - } - - - public void setData(VaultAttributionLoaderResponse data) { - this.data = data; - } - - - public VaultAttributionLoaderResponseRoot meta(Object meta) { - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMeta() { - return meta; - } - - - public void setMeta(Object meta) { - this.meta = meta; - } - - - /** - * Return true if this VaultAttributionLoaderResponseRoot object is equal to o. - */ - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VaultAttributionLoaderResponseRoot vaultAttributionLoaderResponseRoot = (VaultAttributionLoaderResponseRoot) o; - return Objects.equals(this.data, vaultAttributionLoaderResponseRoot.data) && - Objects.equals(this.meta, vaultAttributionLoaderResponseRoot.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VaultAttributionLoaderResponseRoot {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - From 6cff67528c05fdad6c2dd044e4d0e5b46f9d52e7 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 10:54:13 +0000 Subject: [PATCH 05/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- .../java/factset/analyticsapi/engines/api/AccountsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/AfiOptimizerApi.java | 4 ++++ .../factset/analyticsapi/engines/api/AxpOptimizerApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/BenchmarksApi.java | 4 ++++ .../factset/analyticsapi/engines/api/BpmOptimizerApi.java | 4 ++++ .../factset/analyticsapi/engines/api/ColumnStatisticsApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/ColumnsApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/ComponentsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/ConfigurationsApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/CurrenciesApi.java | 4 ++++ .../main/java/factset/analyticsapi/engines/api/DatesApi.java | 4 ++++ .../factset/analyticsapi/engines/api/DiscountCurvesApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/DocumentsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/FiCalculationsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/FiabCalculationsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/FpoOptimizerApi.java | 4 ++++ .../java/factset/analyticsapi/engines/api/FrequenciesApi.java | 4 ++++ .../main/java/factset/analyticsapi/engines/api/GroupsApi.java | 4 ++++ .../analyticsapi/engines/api/LinkedPaTemplatesApi.java | 4 ++++ .../factset/analyticsapi/engines/api/NpoOptimizerApi.java | 4 ++++ .../factset/analyticsapi/engines/api/PaCalculationsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/PricingSourcesApi.java | 4 ++++ .../factset/analyticsapi/engines/api/PubCalculationsApi.java | 4 ++++ .../analyticsapi/engines/api/QuantCalculationsApi.java | 4 ++++ .../factset/analyticsapi/engines/api/SparCalculationsApi.java | 4 ++++ .../analyticsapi/engines/api/StrategyDocumentsApi.java | 4 ++++ .../analyticsapi/engines/api/TemplatedPaComponentsApi.java | 4 ++++ .../analyticsapi/engines/api/UnlinkedPaTemplatesApi.java | 4 ++++ .../analyticsapi/engines/api/VaultCalculationsApi.java | 4 ++++ 29 files changed, 116 insertions(+) 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 d0f19735..8ca7d4e3 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 @@ -19,6 +19,10 @@ import factset.analyticsapi.engines.models.SPARAccountsRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class AccountsApi { private ApiClient apiClient; public AccountsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java index 4a4934eb..c12390bc 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class AfiOptimizerApi { private ApiClient apiClient; public AfiOptimizerApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java index fc90907b..f9f8d227 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class AxpOptimizerApi { private ApiClient apiClient; public AxpOptimizerApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java index 4861ed2d..3ea132fe 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.SPARBenchmarkRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class BenchmarksApi { private ApiClient apiClient; public BenchmarksApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java index dd7451f7..e0530d51 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class BpmOptimizerApi { private ApiClient apiClient; public BpmOptimizerApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java index a61800f7..680ab16e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -17,6 +17,10 @@ import factset.analyticsapi.engines.models.ColumnStatisticRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class ColumnStatisticsApi { private ApiClient apiClient; public ColumnStatisticsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java index 6889b457..64082139 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -19,6 +19,10 @@ import factset.analyticsapi.engines.models.ColumnSummaryRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class ColumnsApi { private ApiClient apiClient; public ColumnsApi() { 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 f7f22832..cdd9addf 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 @@ -21,6 +21,10 @@ import factset.analyticsapi.engines.models.VaultComponentRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class ComponentsApi { private ApiClient apiClient; public ComponentsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 031e51f2..20c68b11 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -19,6 +19,10 @@ import factset.analyticsapi.engines.models.VaultConfigurationSummaryRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class ConfigurationsApi { private ApiClient apiClient; public ConfigurationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java index 2dd44c6d..95f9b233 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -17,6 +17,10 @@ import factset.analyticsapi.engines.models.CurrencyRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class CurrenciesApi { private ApiClient apiClient; public CurrenciesApi() { 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 f6f84ce0..0a45652d 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 @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.DateParametersSummaryRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class DatesApi { private ApiClient apiClient; public DatesApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java index 25991859..2d8ba006 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.FIDiscountCurveInfoRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class DiscountCurvesApi { private ApiClient apiClient; public DiscountCurvesApi() { 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..84bc0111 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 @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.DocumentDirectoriesRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class DocumentsApi { private ApiClient apiClient; public DocumentsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 6a3564fe..3636383b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class FiCalculationsApi { private ApiClient apiClient; public FiCalculationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java index bb5bfcfc..30a047a1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java @@ -19,6 +19,10 @@ import factset.analyticsapi.engines.models.FIABCalculationStatusSummary; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class FiabCalculationsApi { private ApiClient apiClient; public FiabCalculationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java index 5c48f02c..ca1c2655 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class FpoOptimizerApi { private ApiClient apiClient; public FpoOptimizerApi() { 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..4654b192 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 @@ -17,6 +17,10 @@ import factset.analyticsapi.engines.models.FrequencyRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class FrequenciesApi { private ApiClient apiClient; public FrequenciesApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java index 6ac12439..10e46413 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.GroupRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class GroupsApi { private ApiClient apiClient; public GroupsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index a0b911c8..092032cb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -22,6 +22,10 @@ import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class LinkedPaTemplatesApi { private ApiClient apiClient; public LinkedPaTemplatesApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java index a8bb9e89..50d533a3 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java @@ -20,6 +20,10 @@ import factset.analyticsapi.engines.models.ObjectRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class NpoOptimizerApi { private ApiClient apiClient; public NpoOptimizerApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index e8e507f4..2cbccd86 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -21,6 +21,10 @@ import factset.analyticsapi.engines.models.PACalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class PaCalculationsApi { private ApiClient apiClient; public PaCalculationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java index f7a16890..bf72ceb2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.PAPricingSourceRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class PricingSourcesApi { private ApiClient apiClient; public PricingSourcesApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index 2c54e566..7224030b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -21,6 +21,10 @@ import factset.analyticsapi.engines.models.PubCalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class PubCalculationsApi { private ApiClient apiClient; public PubCalculationsApi() { 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 d96e755c..ce7e266a 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 @@ -22,6 +22,10 @@ import factset.analyticsapi.engines.models.QuantCalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class QuantCalculationsApi { private ApiClient apiClient; public QuantCalculationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index 2e2f006e..97fc2fcb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -21,6 +21,10 @@ import factset.analyticsapi.engines.models.SPARCalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class SparCalculationsApi { private ApiClient apiClient; public SparCalculationsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index b31f7a3c..2abf6386 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -18,6 +18,10 @@ import factset.analyticsapi.engines.models.DocumentDirectoriesRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class StrategyDocumentsApi { private ApiClient apiClient; public StrategyDocumentsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index 280f95c9..f0ab350d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -22,6 +22,10 @@ import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class TemplatedPaComponentsApi { private ApiClient apiClient; public TemplatedPaComponentsApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java index 7093fb25..bff54359 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -24,6 +24,10 @@ import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class UnlinkedPaTemplatesApi { private ApiClient apiClient; public UnlinkedPaTemplatesApi() { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index af10462e..ba1af61e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -21,6 +21,10 @@ import factset.analyticsapi.engines.models.VaultCalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") +/** + * @deprecated DEPRECATED! Use Esdk's. + */ +@Deprecated public class VaultCalculationsApi { private ApiClient apiClient; public VaultCalculationsApi() { From 127b09c83ddf561e9ef3ae8e2029296cb68884d2 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 10:57:20 +0000 Subject: [PATCH 06/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- .../main/java/factset/analyticsapi/engines/api/AccountsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AfiOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AxpOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BenchmarksApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BpmOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/ColumnStatisticsApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/ColumnsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/ComponentsApi.java | 2 +- .../factset/analyticsapi/engines/api/ConfigurationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/CurrenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/DatesApi.java | 2 +- .../factset/analyticsapi/engines/api/DiscountCurvesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/DocumentsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiabCalculationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FpoOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FrequenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/GroupsApi.java | 2 +- .../factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/NpoOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/PaCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/PricingSourcesApi.java | 2 +- .../factset/analyticsapi/engines/api/PubCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/QuantCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/SparCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/StrategyDocumentsApi.java | 2 +- .../analyticsapi/engines/api/TemplatedPaComponentsApi.java | 2 +- .../analyticsapi/engines/api/UnlinkedPaTemplatesApi.java | 2 +- .../factset/analyticsapi/engines/api/VaultCalculationsApi.java | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) 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 8ca7d4e3..5cebfb75 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 @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class AccountsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java index c12390bc..c324a4c2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class AfiOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java index f9f8d227..0ab151f7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class AxpOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java index 3ea132fe..9b0e7420 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class BenchmarksApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java index e0530d51..8f016755 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class BpmOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java index 680ab16e..d2849684 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class ColumnStatisticsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java index 64082139..70875c72 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class ColumnsApi { 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 cdd9addf..c020e9f4 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 @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class ComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 20c68b11..918e59be 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class ConfigurationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java index 95f9b233..c7565c3b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class CurrenciesApi { 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 0a45652d..9597f2c3 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class DatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java index 2d8ba006..9504ca9c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class DiscountCurvesApi { 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 84bc0111..a4153bf4 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class DocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 3636383b..282d85b7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class FiCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java index 30a047a1..736e1b8f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class FiabCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java index ca1c2655..700b6607 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class FpoOptimizerApi { 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 4654b192..998a91a9 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 @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class FrequenciesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java index 10e46413..07588eca 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class GroupsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index 092032cb..d9f617ba 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class LinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java index 50d533a3..e7f6e985 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class NpoOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index 2cbccd86..a437c474 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class PaCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java index bf72ceb2..49ed071e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class PricingSourcesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index 7224030b..4a22a424 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class PubCalculationsApi { 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 ce7e266a..728bbff0 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 @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class QuantCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index 97fc2fcb..5bc9c2d6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class SparCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index 2abf6386..7f5f5466 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class StrategyDocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index f0ab350d..ffae88d5 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class TemplatedPaComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java index bff54359..bd1e6ed6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -25,7 +25,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class UnlinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index ba1af61e..2659644f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated DEPRECATED! Use Esdk's. + * @deprecated This library is deprecated. Please use Esdk's. */ @Deprecated public class VaultCalculationsApi { From 0149853b6cf64e1a0bd5590a9d845495cae10882 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 13:00:47 +0000 Subject: [PATCH 07/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- .../main/java/factset/analyticsapi/engines/api/AccountsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AfiOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AxpOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BenchmarksApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BpmOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/ColumnStatisticsApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/ColumnsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/ComponentsApi.java | 2 +- .../factset/analyticsapi/engines/api/ConfigurationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/CurrenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/DatesApi.java | 2 +- .../factset/analyticsapi/engines/api/DiscountCurvesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/DocumentsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiabCalculationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FpoOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FrequenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/GroupsApi.java | 2 +- .../factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/NpoOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/PaCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/PricingSourcesApi.java | 2 +- .../factset/analyticsapi/engines/api/PubCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/QuantCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/SparCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/StrategyDocumentsApi.java | 2 +- .../analyticsapi/engines/api/TemplatedPaComponentsApi.java | 2 +- .../analyticsapi/engines/api/UnlinkedPaTemplatesApi.java | 2 +- .../factset/analyticsapi/engines/api/VaultCalculationsApi.java | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) 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 5cebfb75..cfcf15ce 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 @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AccountsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java index c324a4c2..761b79f6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AfiOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java index 0ab151f7..0c52a4bc 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AxpOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java index 9b0e7420..ded1a28c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class BenchmarksApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java index 8f016755..c22ed867 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class BpmOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java index d2849684..0e149c91 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ColumnStatisticsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java index 70875c72..1d06c97d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ColumnsApi { 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 c020e9f4..fc54ecb4 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 @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 918e59be..7f305f1c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ConfigurationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java index c7565c3b..cc772f97 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class CurrenciesApi { 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 9597f2c3..a414bc69 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java index 9504ca9c..2b0c1023 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DiscountCurvesApi { 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 a4153bf4..96625ea7 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 282d85b7..44303b6c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FiCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java index 736e1b8f..2988de90 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FiabCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java index 700b6607..e67d1235 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FpoOptimizerApi { 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 998a91a9..46040dcf 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 @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FrequenciesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java index 07588eca..6d6bff45 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class GroupsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index d9f617ba..b4058751 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class LinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java index e7f6e985..46bc0319 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class NpoOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index a437c474..545f4c97 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PaCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java index 49ed071e..e967c09d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PricingSourcesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index 4a22a424..088d5937 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PubCalculationsApi { 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 728bbff0..9f2820c4 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 @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class QuantCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index 5bc9c2d6..a1d27ada 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class SparCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index 7f5f5466..c2d5e018 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class StrategyDocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index ffae88d5..e8efff0c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class TemplatedPaComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java index bd1e6ed6..894bc6c1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -25,7 +25,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class UnlinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index 2659644f..83b7df98 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use Esdk's. + * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class VaultCalculationsApi { From 349bfc2145a058bd8a7d18c8eb86c77a78c44d08 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 14:39:42 +0000 Subject: [PATCH 08/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- .../main/java/factset/analyticsapi/engines/api/AccountsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AfiOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AxpOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BenchmarksApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BpmOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/ColumnStatisticsApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/ColumnsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/ComponentsApi.java | 2 +- .../factset/analyticsapi/engines/api/ConfigurationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/CurrenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/DatesApi.java | 2 +- .../factset/analyticsapi/engines/api/DiscountCurvesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/DocumentsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiabCalculationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FpoOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FrequenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/GroupsApi.java | 2 +- .../factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/NpoOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/PaCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/PricingSourcesApi.java | 2 +- .../factset/analyticsapi/engines/api/PubCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/QuantCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/SparCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/StrategyDocumentsApi.java | 2 +- .../analyticsapi/engines/api/TemplatedPaComponentsApi.java | 2 +- .../analyticsapi/engines/api/UnlinkedPaTemplatesApi.java | 2 +- .../factset/analyticsapi/engines/api/VaultCalculationsApi.java | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) 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 cfcf15ce..d6967cde 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 @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class AccountsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java index 761b79f6..b68865c5 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class AfiOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java index 0c52a4bc..fcc19974 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class AxpOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java index ded1a28c..7d1b298b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class BenchmarksApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java index c22ed867..72146662 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class BpmOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java index 0e149c91..a790fce3 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class ColumnStatisticsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java index 1d06c97d..f19f27c1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class ColumnsApi { 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 fc54ecb4..3d23e77c 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 @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class ComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 7f305f1c..6e5950b0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class ConfigurationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java index cc772f97..66c2af13 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class CurrenciesApi { 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 a414bc69..f48546c8 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class DatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java index 2b0c1023..5b79a015 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class DiscountCurvesApi { 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 96625ea7..fcbb9c61 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class DocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 44303b6c..2ea5a578 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class FiCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java index 2988de90..1bbe6bbd 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class FiabCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java index e67d1235..73ad3197 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class FpoOptimizerApi { 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 46040dcf..283edea5 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 @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class FrequenciesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java index 6d6bff45..5e0cf80a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class GroupsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index b4058751..4aa3d492 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class LinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java index 46bc0319..b121f7d7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class NpoOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index 545f4c97..41203b16 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class PaCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java index e967c09d..ec0e4603 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class PricingSourcesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index 088d5937..fc245f15 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class PubCalculationsApi { 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 9f2820c4..784716aa 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 @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class QuantCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index a1d27ada..71e29e13 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class SparCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index c2d5e018..a2b4bf54 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class StrategyDocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index e8efff0c..02f7bdc0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class TemplatedPaComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java index 894bc6c1..d2ac93a8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -25,7 +25,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class UnlinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index 83b7df98..c9720508 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + * @deprecated This library is deprecated. */ @Deprecated public class VaultCalculationsApi { From f3d4dd471f8aebb4617afd898b3c56d8d22c5a7c Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 14:49:44 +0000 Subject: [PATCH 09/13] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.3.0 --- .../main/java/factset/analyticsapi/engines/api/AccountsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AfiOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/AxpOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BenchmarksApi.java | 2 +- .../java/factset/analyticsapi/engines/api/BpmOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/ColumnStatisticsApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/ColumnsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/ComponentsApi.java | 2 +- .../factset/analyticsapi/engines/api/ConfigurationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/CurrenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/DatesApi.java | 2 +- .../factset/analyticsapi/engines/api/DiscountCurvesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/DocumentsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/FiabCalculationsApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FpoOptimizerApi.java | 2 +- .../java/factset/analyticsapi/engines/api/FrequenciesApi.java | 2 +- .../main/java/factset/analyticsapi/engines/api/GroupsApi.java | 2 +- .../factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java | 2 +- .../java/factset/analyticsapi/engines/api/NpoOptimizerApi.java | 2 +- .../factset/analyticsapi/engines/api/PaCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/PricingSourcesApi.java | 2 +- .../factset/analyticsapi/engines/api/PubCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/QuantCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/SparCalculationsApi.java | 2 +- .../factset/analyticsapi/engines/api/StrategyDocumentsApi.java | 2 +- .../analyticsapi/engines/api/TemplatedPaComponentsApi.java | 2 +- .../analyticsapi/engines/api/UnlinkedPaTemplatesApi.java | 2 +- .../factset/analyticsapi/engines/api/VaultCalculationsApi.java | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) 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 d6967cde..2727d4ed 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 @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AccountsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java index b68865c5..284a0f26 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AfiOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java index fcc19974..eaa9c4b7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class AxpOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java index 7d1b298b..71533629 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class BenchmarksApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java index 72146662..a956fa2f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class BpmOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java index a790fce3..dbf3e625 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ColumnStatisticsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java index f19f27c1..110663eb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ColumnsApi { 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 3d23e77c..18a8a723 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 @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java index 6e5950b0..58e3eb74 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ConfigurationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class ConfigurationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java index 66c2af13..885a5d8c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/CurrenciesApi.java @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class CurrenciesApi { 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 f48546c8..ecd48c9f 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java index 5b79a015..42491054 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DiscountCurvesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DiscountCurvesApi { 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 fcbb9c61..87f3171d 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 @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class DocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java index 2ea5a578..32a89317 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiCalculationsApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FiCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java index 1bbe6bbd..03835207 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java @@ -20,7 +20,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FiabCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java index 73ad3197..7a7dd680 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FpoOptimizerApi { 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 283edea5..9220eeaa 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 @@ -18,7 +18,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class FrequenciesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java index 5e0cf80a..3b49dc3d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/GroupsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class GroupsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java index 4aa3d492..9265537a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class LinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java index b121f7d7..8766f6a5 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java @@ -21,7 +21,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class NpoOptimizerApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java index 41203b16..0b83a156 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PaCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java index ec0e4603..107a0086 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PricingSourcesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java index fc245f15..c686ad1d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class PubCalculationsApi { 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 784716aa..16907194 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 @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class QuantCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java index 71e29e13..2dd91a3a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class SparCalculationsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java index a2b4bf54..f1296cd8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java @@ -19,7 +19,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class StrategyDocumentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java index 02f7bdc0..3e63ba79 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -23,7 +23,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class TemplatedPaComponentsApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java index d2ac93a8..badddb8c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -25,7 +25,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class UnlinkedPaTemplatesApi { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java index c9720508..1bbdbadc 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java @@ -22,7 +22,7 @@ @javax.annotation.Generated(value = "CustomJavaClientCodegen") /** - * @deprecated This library is deprecated. + * @deprecated This library is deprecated.Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. */ @Deprecated public class VaultCalculationsApi { From 6de7668f8e12d0e7ec34bddef2b1b8cc6bcd65bb Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Fri, 17 Oct 2025 12:23:03 +0530 Subject: [PATCH 10/13] updated the latest version --- tests/pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/pom.xml b/tests/pom.xml index 44007459..3e9aea82 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -116,7 +116,7 @@ system - ${project.basedir}/../auto-generated-sdk/target/engines-sdk-6.2.0.jar + ${project.basedir}/../auto-generated-sdk/target/engines-sdk-6.3.0.jar com.factset.analyticsapi engines-sdk ${engines-sdk-version} @@ -142,7 +142,7 @@ 4.13.1 3.25.1 1.6.0 - 6.2.0 + 6.3.0 4.0.1 From 795ea9f15fc8cd9577459c1439eab14c9bf6cb9e Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Wed, 22 Oct 2025 18:12:15 +0530 Subject: [PATCH 11/13] deprecate messages added --- auto-generated-sdk/README.md | 2 ++ auto-generated-sdk/pom.xml | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 47b616fe..a97ea7b3 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -1,3 +1,5 @@ +## 🚨 THIS PACKAGE IS DEPRECATED! +Please use instead. # engines-sdk diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index d0c0b218..b25f940c 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -331,5 +331,9 @@ 2.9.10 1.3.2 4.13.1 + true + + DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + \ No newline at end of file From 78d762834c5a5ffb21a55f6a31872954e75e7bec Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Wed, 22 Oct 2025 18:18:15 +0530 Subject: [PATCH 12/13] Update pom.xml --- auto-generated-sdk/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index b25f940c..d653cdc7 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -333,7 +333,7 @@ 4.13.1 true - DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. \ No newline at end of file From b1c65fa517fd38e49b7d89ef6b7a6380560cdf56 Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Wed, 22 Oct 2025 19:41:41 +0530 Subject: [PATCH 13/13] Update pom.xml --- auto-generated-sdk/pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index d653cdc7..72a7ef1c 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -7,7 +7,7 @@ engines-sdk 6.3.0 https://github.com/factset/analyticsapi-engines-java-sdk - DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + DEPRECATED: This package is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. ossrh @@ -333,7 +333,7 @@ 4.13.1 true - DEPRECATED: This library is no longer maintained. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. + DEPRECATED: This package is deprecated. Please use https://central.sonatype.com/search?q=com.factset.sdk&smo=true instead. \ No newline at end of file