diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index 729761b0..95e340c6 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -69,6 +69,8 @@ docs/FIABCalculationStatus.md docs/FIABCalculationStatusSummary.md docs/FIABDateParameters.md docs/FIABIdentifier.md +docs/FIAttributionForJobSettings.md +docs/FIAttributionForSecurities.md docs/FIBalloonExtension.md docs/FIBankLoans.md docs/FICalculationParameters.md @@ -186,6 +188,8 @@ docs/SPARBenchmark.md docs/SPARBenchmarkRoot.md docs/SPARCalculationParameters.md docs/SPARCalculationParametersRoot.md +docs/SPARComponent.md +docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md docs/SparCalculationsApi.md @@ -219,6 +223,9 @@ docs/UnlinkedPATemplateSummaryRoot.md docs/UnlinkedPATemplateUpdateParameters.md docs/UnlinkedPATemplateUpdateParametersRoot.md docs/UnlinkedPaTemplatesApi.md +docs/VaultAttributionLoaderApi.md +docs/VaultAttributionLoaderResponse.md +docs/VaultAttributionLoaderResponseRoot.md docs/VaultCalculationParameters.md docs/VaultCalculationParametersRoot.md docs/VaultCalculationsApi.md @@ -279,6 +286,7 @@ 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 @@ -336,6 +344,8 @@ src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatus.java src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatusSummary.java src/main/java/factset/analyticsapi/engines/models/FIABDateParameters.java src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java +src/main/java/factset/analyticsapi/engines/models/FIAttributionForJobSettings.java +src/main/java/factset/analyticsapi/engines/models/FIAttributionForSecurities.java src/main/java/factset/analyticsapi/engines/models/FIBalloonExtension.java src/main/java/factset/analyticsapi/engines/models/FIBankLoans.java src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java @@ -442,6 +452,8 @@ src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/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 @@ -471,6 +483,8 @@ src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java +src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/VaultComponent.java diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index ef28087f..2f18d0bc 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -167,6 +167,7 @@ Class | Method | HTTP request | Description *ColumnsApi* | [**getPAColumns**](docs/ColumnsApi.md#getPAColumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns *ComponentsApi* | [**getPAComponentById**](docs/ComponentsApi.md#getPAComponentById) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id *ComponentsApi* | [**getPAComponents**](docs/ComponentsApi.md#getPAComponents) | **GET** /analytics/engines/pa/v3/components | Get PA components +*ComponentsApi* | [**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 @@ -258,6 +259,7 @@ Class | Method | HTTP request | Description *UnlinkedPaTemplatesApi* | [**getUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#getUnlinkedPATemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates *UnlinkedPaTemplatesApi* | [**getUnlinkedPATemplatesById**](docs/UnlinkedPaTemplatesApi.md#getUnlinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id *UnlinkedPaTemplatesApi* | [**updateUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#updateUnlinkedPATemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template +*VaultAttributionLoaderApi* | [**vaultAttributionLoader**](docs/VaultAttributionLoaderApi.md#vaultAttributionLoader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader *VaultCalculationsApi* | [**cancelCalculationById**](docs/VaultCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id *VaultCalculationsApi* | [**getAllCalculations**](docs/VaultCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations *VaultCalculationsApi* | [**getCalculationParameters**](docs/VaultCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id @@ -320,6 +322,8 @@ Class | Method | HTTP request | Description - [FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md) - [FIABDateParameters](docs/FIABDateParameters.md) - [FIABIdentifier](docs/FIABIdentifier.md) + - [FIAttributionForJobSettings](docs/FIAttributionForJobSettings.md) + - [FIAttributionForSecurities](docs/FIAttributionForSecurities.md) - [FIBalloonExtension](docs/FIBalloonExtension.md) - [FIBankLoans](docs/FIBankLoans.md) - [FICalculationParameters](docs/FICalculationParameters.md) @@ -426,6 +430,8 @@ Class | Method | HTTP request | Description - [SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md) - [SPARCalculationParameters](docs/SPARCalculationParameters.md) - [SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md) + - [SPARComponent](docs/SPARComponent.md) + - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) - [TemplateContentTypes](docs/TemplateContentTypes.md) @@ -455,6 +461,8 @@ Class | Method | HTTP request | Description - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) + - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) + - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) - [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md) - [VaultComponent](docs/VaultComponent.md) diff --git a/auto-generated-sdk/api/openapi.yaml b/auto-generated-sdk/api/openapi.yaml index 19ee46ac..51e2b57f 100644 --- a/auto-generated-sdk/api/openapi.yaml +++ b/auto-generated-sdk/api/openapi.yaml @@ -8415,28 +8415,27 @@ paths: - status-code: "200" response-type: ComponentSummaryRoot x-accepts: application/json - /analytics/engines/vault/v3/components: + /analytics/engines/spar/v3/components/{id}: get: - description: This endpoint returns the list of Vault components in a given Vault - document. - operationId: getVaultComponents + description: This endpoint returns the default settings of a SPAR component. + operationId: getSPARComponentById parameters: - - description: Document Name - explode: true - in: query - name: document + - description: Unique identifier for a SPAR component + explode: false + in: path + name: id required: true schema: - description: Document Name + description: Unique identifier for a SPAR component type: string - style: form + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ComponentSummaryRoot' - description: Expected response, returns a list of Vault components. + $ref: '#/components/schemas/SPARComponentRoot' + description: Expected response, returns the default settings of a SPAR component. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8477,8 +8476,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter provided or invalid Vault document - name. + description: Invalid SPAR component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8519,7 +8517,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault Document not found. + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8714,36 +8712,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault components + summary: Get SPAR component by id tags: - Components x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ComponentSummaryRoot + response-type: SPARComponentRoot x-accepts: application/json - /analytics/engines/vault/v3/components/{id}: + /analytics/engines/vault/v3/components: get: - description: This endpoint returns the default settings of a Vault component. - operationId: getVaultComponentById + description: This endpoint returns the list of Vault components in a given Vault + document. + operationId: getVaultComponents 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 + description: Document Name 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 Vault components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8784,7 +8782,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Vault component id. + description: Invalid query parameter provided or invalid Vault document + name. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -8825,7 +8824,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault Component not found. + description: Vault Document not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9020,38 +9019,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault component by id + summary: Get Vault 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/vault/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 Vault component. + operationId: getVaultComponentById parameters: - - description: Required account query parameter to filter configurations for - a specific account - explode: true - in: query - name: account + - description: Unique identifier for a vault component + explode: false + in: path + name: id required: true schema: - description: Required account query parameter to filter configurations for - a specific account + description: Unique identifier for a vault component 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/VaultComponentRoot' + description: Expected response, returns the default settings of a Vault + component. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9092,7 +9089,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid account. + description: Invalid Vault component id. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9133,7 +9130,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Account not found. + description: Vault Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9328,36 +9325,38 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configurations + summary: Get Vault 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: VaultComponentRoot x-accepts: application/json - /analytics/engines/vault/v3/configurations/{id}: + /analytics/engines/vault/v3/configurations: 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 all the Vault configurations saved in the + provided account. + operationId: getVaultConfigurations parameters: - - description: Vault configuration id to get the details of - 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: Vault configuration id to get the details of + description: Required account query parameter to filter configurations for + a specific account type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VaultConfigurationRoot' - description: Expected response, returns details for a Vault configuration. + $ref: '#/components/schemas/VaultConfigurationSummaryRoot' + description: Expected response, returns a dictionary of Vault configurations. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9398,7 +9397,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid vault configuration code. + description: Invalid account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9439,7 +9438,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Vault configuration id not found. + description: Account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9634,26 +9633,36 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault configuration by id + summary: Get Vault configurations tags: - Configurations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultConfigurationRoot + response-type: VaultConfigurationSummaryRoot x-accepts: application/json - /analytics/lookups/v3/currencies: + /analytics/engines/vault/v3/configurations/{id}: get: - description: This endpoint lists all the currencies that can be applied to any - calculation. - operationId: getCurrencies + description: This endpoint returns details for a Vault configuration as well + as a list of accounts it is used in. + operationId: getVaultConfigurationById + parameters: + - description: Vault configuration id to get the details of + explode: false + in: path + name: id + required: true + schema: + description: Vault configuration id to get the details of + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CurrencyRoot' - description: Expected response, returns a list of currencies. + $ref: '#/components/schemas/VaultConfigurationRoot' + description: Expected response, returns details for a Vault configuration. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9689,27 +9698,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 vault configuration code. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9745,8 +9739,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: Vault configuration id not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9782,9 +9780,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. @@ -9802,16 +9799,8 @@ paths: available after successful authentication. type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -9829,85 +9818,26 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. explode: false schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. type: string style: simple - summary: Get 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 - type: string - style: form - - description: End Date - explode: true - in: query - name: enddate - required: true - schema: - description: End Date - type: string - style: form - - description: Component Id - explode: true - in: query - name: componentid - required: true - schema: - description: 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: + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false schema: - $ref: '#/components/schemas/DateParametersSummaryRoot' - description: Expected response, returns the converted dates in yyyymmdd - format. + 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. @@ -9943,12 +9873,9 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value is 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. @@ -9966,30 +9893,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: Get Vault configuration by id + tags: + - Configurations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: VaultConfigurationRoot + x-accepts: application/json + /analytics/lookups/v3/currencies: + get: + description: This endpoint lists all the currencies that can be applied to any + calculation. + operationId: getCurrencies + responses: + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Document or account 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. @@ -10184,21 +10153,21 @@ paths: available after successful authentication. type: string style: simple - summary: Convert PA dates to absolute format + summary: Get currencies tags: - - Dates + - Currencies x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DateParametersSummaryRoot + response-type: CurrencyRoot x-accepts: application/json - /analytics/engines/vault/v3/dates: + /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 Vault calculation. For more information - on FactSet date format, please refer to the Vault API documentation under + 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: convertVaultDatesToAbsoluteFormat + operationId: convertPADatesToAbsoluteFormat parameters: - description: Start Date explode: true @@ -10218,13 +10187,13 @@ paths: description: End Date type: string style: form - - description: Vault Component Id + - description: Component Id explode: true in: query name: componentid required: true schema: - description: Vault Component Id + description: Component Id type: string style: form - description: Account @@ -10325,7 +10294,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: vault Document or account not found. + description: Document or account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10520,7 +10489,7 @@ paths: available after successful authentication. type: string style: simple - summary: Convert Vault dates to absolute format + summary: Convert PA dates to absolute format tags: - Dates x-are-multiple-success-responses-different: false @@ -10528,17 +10497,48 @@ paths: - status-code: "200" response-type: DateParametersSummaryRoot x-accepts: application/json - /analytics/engines/fi/v3/discount-curves: + /analytics/engines/vault/v3/dates: get: - description: This endpoint lists all the discount curves that can be applied - to a FI calculation. - operationId: getAllFIDiscountCurves + 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: - - explode: true + - description: Start Date + explode: true in: query - name: currency + 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 responses: @@ -10546,8 +10546,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FIDiscountCurveInfoRoot' - description: Expected response, returns a list of FI discount curves. + $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. @@ -10588,7 +10630,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Not found + description: vault Document or account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10783,78 +10825,34 @@ paths: available after successful authentication. type: string style: simple - summary: Get Discount Curves + summary: Convert Vault dates to absolute format tags: - - DiscountCurves + - Dates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: FIDiscountCurveInfoRoot + response-type: DateParametersSummaryRoot x-accepts: application/json - /analytics/engines/pa/v3/documents/{path}: + /analytics/engines/fi/v3/discount-curves: get: - description: This endpoint looks up all PA3 documents and sub-directories in - a given directory. - operationId: getPA3Documents + description: This endpoint lists all the discount curves that can be applied + to a FI calculation. + operationId: getAllFIDiscountCurves parameters: - - description: The directory to get the documents and sub-directories in - explode: false - in: path - name: path - required: true + - explode: true + in: query + name: currency + required: false schema: - default: "" - description: The directory to get the documents and sub-directories in type: string - style: simple + style: form 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: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: 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 + $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. @@ -10895,7 +10893,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -10932,7 +10930,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. @@ -10988,7 +10986,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. @@ -11053,7 +11051,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. @@ -11072,7 +11070,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. @@ -11090,28 +11088,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA3 documents and sub-directories in a directory + summary: Get Discount Curves tags: - - Documents + - DiscountCurves x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: FIDiscountCurveInfoRoot x-accepts: application/json - /analytics/engines/vault/v3/documents/{path}: + /analytics/engines/pa/v3/documents/{path}: get: - description: This endpoint looks up all Vault documents and sub-directories - in a given directory. - operationId: getVaultDocuments + 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 in + - description: The directory to get the documents and sub-directories in explode: false in: path name: path required: true schema: default: "" - description: The directory to get the documents in + description: The directory to get the documents and sub-directories in type: string style: simple responses: @@ -11120,7 +11118,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Vault documents and directories + description: Expected response, returns a list of PA3 documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11397,7 +11395,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault documents and sub-directories in a directory + summary: Get PA3 documents and sub-directories in a directory tags: - Documents x-are-multiple-success-responses-different: false @@ -11405,11 +11403,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/spar/v3/documents/{path}: + /analytics/engines/vault/v3/documents/{path}: get: - description: This endpoint looks up all SPAR3 documents and sub-directories + description: This endpoint looks up all Vault documents and sub-directories in a given directory. - operationId: getSPAR3Documents + operationId: getVaultDocuments parameters: - description: The directory to get the documents in explode: false @@ -11427,7 +11425,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of SPAR3 documents and directories + description: Expected response, returns a list of Vault documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -11704,7 +11702,7 @@ paths: available after successful authentication. type: string style: simple - summary: Gets SPAR3 documents and sub-directories in a directory + summary: Get Vault documents and sub-directories in a directory tags: - Documents x-are-multiple-success-responses-different: false @@ -11712,11 +11710,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/pub/v3/documents/{path}: + /analytics/engines/spar/v3/documents/{path}: get: - description: This endpoint looks up all Publisher documents and sub-directories + description: This endpoint looks up all SPAR3 documents and sub-directories in a given directory. - operationId: getPubDocuments + operationId: getSPAR3Documents parameters: - description: The directory to get the documents in explode: false @@ -11734,8 +11732,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Publisher documents and - directories + description: Expected response, returns a list of SPAR3 documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12012,7 +12009,7 @@ paths: available after successful authentication. type: string style: simple - summary: Gets Publisher documents and sub-directories in a directory + summary: Gets SPAR3 documents and sub-directories in a directory tags: - Documents x-are-multiple-success-responses-different: false @@ -12020,19 +12017,30 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/fiab/v1/calculations: + /analytics/engines/pub/v3/documents/{path}: get: - description: This endpoints returns all FIAB calculation requests. - operationId: getCalculationStatusSummaries + description: This endpoint looks up all Publisher documents and sub-directories + in a given directory. + operationId: getPubDocuments + parameters: + - description: The directory to get the documents in + explode: false + in: path + name: path + required: true + schema: + default: "" + description: The directory to get the documents in + type: string + style: simple responses: "200": content: application/json: schema: - additionalProperties: - $ref: '#/components/schemas/FIABCalculationStatusSummary' - type: object - description: List of active FIAB calculation requests. + $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. @@ -12068,27 +12076,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 query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12124,8 +12117,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: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12161,9 +12158,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. @@ -12181,16 +12177,8 @@ paths: available after successful authentication. type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -12208,56 +12196,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 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. + 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 + "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 @@ -12274,49 +12233,74 @@ 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 - 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. + "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-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 + 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 - "400": - description: Invalid POST body. + "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. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: URL to check status of the request. + description: FactSet's request key header. type: string style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in some time + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -12333,19 +12317,340 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FIAB request limit. + 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. + 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: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: 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 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 + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FIAB request limit. + explode: false + schema: + description: Maximum FIAB request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FIAB requests remaining till request limit reached. + explode: false + schema: + description: Number of FIAB requests remaining till request limit + reached. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + description: Invalid 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 + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FIAB request limit. + explode: false + schema: + description: Maximum FIAB request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FIAB requests remaining till request limit reached. + explode: false + schema: + description: Number of FIAB requests remaining till request limit + reached. type: string style: simple X-FactSet-Api-RateLimit-Limit: @@ -21937,13 +22242,22 @@ paths: description: "This endpoint runs the PA calculation specified in the POST body\ \ parameters.\r\nIt can take one or more calculation units as input.\r\n\r\ \nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override\ - \ over the settings saved in the PA template.\r\n\r\n* If we are overriding\ - \ the grouping with a frequency, we will be overriding the grouping saved\ - \ to the original component and also overriding \r\n the default frequency\ - \ of the Beginning of Period to whatever we pass in the request body.\r\n\ - \ \r\n* If we are overriding gouping frequency without overriding the\ - \ group id it will not be applied to the default groupings saved to the original\ - \ component." + \ 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 gouping 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: Long running deadline in seconds when only one unit is passed @@ -22915,13 +23229,22 @@ paths: \ the PUT body parameters. This also allows creating new PA calculations with\ \ custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\ \nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override\ - \ over the settings saved in the PA template.\r\n\r\n* If we are overriding\ - \ the grouping with a frequency, we will be overriding the grouping saved\ - \ to the original component and also overriding \r\n the default frequency\ - \ of the Beginning of Period to whatever we pass in the request body.\r\n\ - \ \r\n* If we are overriding gouping frequency without overriding the\ - \ group id it will not be applied to the default groupings saved to the original\ - \ component." + \ 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 gouping 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: from url, provided from the location header in the Create and @@ -27279,23 +27602,14 @@ paths: schema: $ref: '#/components/schemas/QuantCalculationParametersRoot' responses: - "202": + "200": content: application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + description: Expected response if the calculation has one unit and is completed + with an error. 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 @@ -27332,12 +27646,10 @@ paths: style: simple "201": content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + application/octet-stream: schema: - $ref: '#/components/schemas/ObjectRoot' + 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. @@ -27376,17 +27688,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. + 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 @@ -27426,9 +27741,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: @@ -27465,15 +27777,27 @@ paths: schema: type: string style: simple - "404": - content: - application/json: + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27509,8 +27833,12 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "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. @@ -27528,8 +27856,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 + "413": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Request body too large headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -27692,11 +28042,11 @@ paths: - QuantCalculations x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "202" + - status-code: "200" response-type: CalculationStatusRoot - status-code: "201" - response-type: ObjectRoot - - status-code: "200" + is-file: true + - status-code: "202" response-type: CalculationStatusRoot x-contentType: application/json x-accepts: application/json @@ -28251,65 +28601,11 @@ paths: $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: @@ -28349,12 +28645,10 @@ paths: style: simple "201": content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + application/octet-stream: schema: - $ref: '#/components/schemas/ObjectRoot' + 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. @@ -28393,104 +28687,61 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: 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": + "202": 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/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Location: + description: URL to poll for the resulting calculation explode: false schema: + description: URL to poll for the resulting calculation 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 + "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 @@ -28581,6 +28832,129 @@ paths: 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 + "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-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: 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' + 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 "415": description: Missing/Invalid Content-Type header. Header needs to be set to application/json. @@ -28708,12 +29082,12 @@ paths: - 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 + is-file: true + - status-code: "202" + response-type: CalculationStatusRoot x-contentType: application/json x-accepts: application/json /analytics/engines/quant/v3/calculations/{id}/status: @@ -29081,14 +29455,6 @@ paths: responses: "200": content: - application/json: - schema: - format: binary - type: string - application/x-protobuf: - schema: - format: binary - type: string application/octet-stream: schema: format: binary @@ -29160,117 +29526,105 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + description: Invalid identifier provided. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: 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: 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 + 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. @@ -29384,14 +29738,6 @@ paths: responses: "200": content: - application/json: - schema: - format: binary - type: string - application/x-protobuf: - schema: - format: binary - type: string application/octet-stream: schema: format: binary @@ -29462,12 +29808,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. headers: X-DataDirect-Request-Key: @@ -29504,19 +29844,27 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + "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/octet-stream: + description: FactSet's request key header. + type: string + 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. @@ -29552,27 +29900,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: 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. @@ -31664,27 +31998,470 @@ 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 + "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: + default: "" + description: The directory to get the strategy documents and sub-directories + in + 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: - 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 query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31720,28 +32497,12 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false + "404": + content: + application/json: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. + $ref: '#/components/schemas/ClientErrorResponse' + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31759,82 +32520,27 @@ paths: 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. + 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 + "401": + description: Missing or invalid authentication + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -31851,33 +32557,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 identifier provided. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31913,16 +32594,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. @@ -31958,27 +32631,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31996,20 +32651,9 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. explode: false schema: type: string @@ -32035,7 +32679,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in sometime. + description: Request timed out. Retry the request in some time headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -32053,19 +32697,19 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation result by id + summary: Get Axioma Equity strategy documents and sub-directories in a directory tags: - - SPARCalculations + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ObjectRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/axp/v3/strategies/{path}: + /analytics/engines/afi/v3/strategies/{path}: get: - description: This endpoint looks up all Axioma Equity strategy documents and - sub-directories in a given directory. - operationId: getAxiomaEquityStrategyDocuments + description: This endpoint looks up all Axioma FI strategy documents and sub-directories + in a given directory. + operationId: getAxiomaFIStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -32085,8 +32729,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma Equity strategy - documents and directories + description: Expected response, returns a list of Axioma FI strategy documents + and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -32363,7 +33007,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma Equity strategy documents and sub-directories in a directory + summary: Get Axioma FI strategy documents and sub-directories in a directory tags: - StrategyDocuments x-are-multiple-success-responses-different: false @@ -32371,11 +33015,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/afi/v3/strategies/{path}: + /analytics/engines/bpm/v3/strategies/{path}: get: - description: This endpoint looks up all Axioma FI strategy documents and sub-directories + description: This endpoint looks up all Barra strategy documents and sub-directories in a given directory. - operationId: getAxiomaFIStrategyDocuments + operationId: getBarraStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -32395,7 +33039,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma FI strategy documents + description: Expected response, returns a list of Barra strategy documents and directories headers: X-DataDirect-Request-Key: @@ -32673,7 +33317,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma FI strategy documents and sub-directories in a directory + summary: Get Barra strategy documents and sub-directories in a directory tags: - StrategyDocuments x-are-multiple-success-responses-different: false @@ -32681,11 +33325,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/bpm/v3/strategies/{path}: + /analytics/engines/npo/v3/strategies/{path}: get: - description: This endpoint looks up all Barra strategy documents and sub-directories + description: This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. - operationId: getBarraStrategyDocuments + operationId: getNorthfieldStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -32705,7 +33349,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Barra strategy documents + description: Expected response, returns a list of Northfield strategy documents and directories headers: X-DataDirect-Request-Key: @@ -32983,7 +33627,7 @@ paths: available after successful authentication. type: string style: simple - summary: Get Barra strategy documents and sub-directories in a directory + summary: Get Northfield strategy documents and sub-directories in a directory tags: - StrategyDocuments x-are-multiple-success-responses-different: false @@ -32991,11 +33635,11 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/npo/v3/strategies/{path}: + /analytics/engines/fpo/v3/strategies/{path}: get: - description: This endpoint looks up all Northfield strategy documents and sub-directories - in a given directory. - operationId: getNorthfieldStrategyDocuments + description: This endpoint looks up all FactSet Portfolio Optimizer strategy + documents and sub-directories in a given directory. + operationId: getFPOStrategyDocuments parameters: - description: The directory to get the strategy documents and sub-directories in @@ -33015,8 +33659,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Northfield strategy documents - and directories + description: Expected response, returns a list of FactSet Portfolio Optimizer + strategy documents and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33293,7 +33937,8 @@ paths: available after successful authentication. type: string style: simple - summary: Get Northfield strategy documents and sub-directories in a directory + summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories + in a directory tags: - StrategyDocuments x-are-multiple-success-responses-different: false @@ -33301,32 +33946,27 @@ paths: - status-code: "200" response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/fpo/v3/strategies/{path}: + /analytics/engines/pa/v3/templated-components: get: - description: This endpoint looks up all FactSet Portfolio Optimizer strategy - documents and sub-directories in a given directory. - operationId: getFPOStrategyDocuments + description: This endpoint returns the list of templated PA components in path. + operationId: getTemplatedPAComponentsInPath parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path + - description: Get templated PA components in path + explode: true + in: query + name: directory required: true schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in + description: Get templated PA components in path type: string - style: simple + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of FactSet Portfolio Optimizer - strategy documents and directories + $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' + description: Expected response, returns a list templated PA components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33367,48 +34007,8 @@ 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 data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33445,7 +34045,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. @@ -33501,7 +34101,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. @@ -33566,7 +34166,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. @@ -33585,7 +34185,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. @@ -33603,36 +34203,56 @@ paths: available after successful authentication. type: string style: simple - summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories - in a directory + summary: Get templated PA components in path tags: - - StrategyDocuments + - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: TemplatedPAComponentSummaryRoot 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 + 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 gouping frequency\ + \ without overriding the group id it will not be applied to the default groupings\ + \ saved to the original component." + operationId: createTemplatedPAComponents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentParametersRoot' + description: Request Parameters required: true - schema: - description: Get templated PA components in path - type: string - style: form responses: - "200": + "201": content: + text/plain: + schema: + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' application/json: schema: - $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' - description: Expected response, returns a list templated PA components. + $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. @@ -33670,9 +34290,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: @@ -33766,6 +34392,43 @@ 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: @@ -33869,48 +34532,32 @@ paths: available after successful authentication. type: string style: simple - summary: Get templated PA components in path + summary: Create templated PA component tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: TemplatedPAComponentSummaryRoot + - status-code: "201" + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json x-accepts: application/json - post: - description: "This endpoint creates new component based off of linked PA template\ - \ or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the\ - \ POST body will act as a one-time override over the settings saved in the\ - \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\ - \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\ - \ totals as well but if we don't pass anything that defaults to securities.\r\ - \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\ - \ the grouping saved to the original component and also overriding \r\n \ - \ the default frequency of the Beginning of Period to whatever we pass in\ - \ the request body.\r\n \r\n* If we are overriding gouping frequency\ - \ without overriding the group id it will not be applied to the default groupings\ - \ saved to the original component." - operationId: createTemplatedPAComponents - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentParametersRoot' - description: Request Parameters + /analytics/engines/pa/v3/templated-components/{id}: + delete: + description: This endpoint deletes an existing templated PA component + operationId: deleteTemplatedPAComponents + parameters: + - description: Unique identifier for a templated PA component + explode: false + in: path + name: id required: true + schema: + description: Unique identifier for a templated PA component + type: string + style: simple responses: - "201": - content: - text/plain: - schema: - $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' - application/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' - text/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' - description: Expected response, templated PA component created successfully. + "204": + description: Expected response, deleted the templated PA component successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -33994,27 +34641,18 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false + "404": + content: + text/plain: schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false + $ref: '#/components/schemas/ClientErrorResponse' + application/json: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34050,8 +34688,27 @@ paths: schema: type: string style: simple - "404": - description: Template not found. + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34190,19 +34847,16 @@ paths: available after successful authentication. type: string style: simple - summary: Create templated PA component + summary: Delete templated PA component tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "201" - response-type: TemplatedPAComponentPostSummaryRoot - x-contentType: application/json + - status-code: "204" x-accepts: application/json - /analytics/engines/pa/v3/templated-components/{id}: - delete: - description: This endpoint deletes an existing templated PA component - operationId: deleteTemplatedPAComponents + get: + description: This endpoint fetches the templated PA component settings. + operationId: getTemplatedPAComponentById parameters: - description: Unique identifier for a templated PA component explode: false @@ -34214,8 +34868,12 @@ paths: type: string style: simple responses: - "204": - description: Expected response, deleted the templated PA component successfully. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentRoot' + description: Expected response, templated PA component details. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34253,15 +34911,9 @@ paths: style: simple "400": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid data provided. Please check the request parameters before attempting again. headers: @@ -34301,16 +34953,10 @@ paths: style: simple "404": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Component not found. + description: Templated PA component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34505,16 +35151,36 @@ paths: available after successful authentication. type: string style: simple - summary: Delete templated PA component + summary: Get templated PA component by id tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: TemplatedPAComponentRoot x-accepts: application/json - get: - description: This endpoint fetches the templated PA component settings. - operationId: getTemplatedPAComponentById + put: + description: "This endpoint allows the user to change the request body from\ + \ an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings\ + \ in the POST body will act as a one-time override over the settings saved\ + \ in the PA template.\r\n\r\n* 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 gouping\ + \ frequency without overriding the group id it will not be applied to the\ + \ default groupings saved to the original component." + operationId: updateTemplatedPAComponents parameters: - description: Unique identifier for a templated PA component explode: false @@ -34525,13 +35191,20 @@ paths: description: Unique identifier for a templated PA component type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot' + description: Request Parameters + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TemplatedPAComponentRoot' - description: Expected response, templated PA component details. + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + description: Expected response, updated successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34614,7 +35287,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Templated PA component not found. + description: Component or template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34809,52 +35482,45 @@ paths: available after successful authentication. type: string style: simple - summary: Get templated PA component by id + summary: Update templated PA component tags: - TemplatedPAComponents x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: TemplatedPAComponentRoot + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json x-accepts: application/json - put: - description: "This endpoint allows the user to change the request body from\ - \ an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings\ - \ in the POST body will act as a one-time override over the settings saved\ - \ in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\ - \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ - \ and totals as well but if we don't pass anything that defaults to securities.\r\ - \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\ - \ the grouping saved to the original component and also overriding \r\n \ - \ the default frequency of the Beginning of Period to whatever we pass in\ - \ the request body.\r\n \r\n* If we are overriding gouping frequency\ - \ without overriding the group id it will not be applied to the default groupings\ - \ saved to the original component." - operationId: updateTemplatedPAComponents + /analytics/engines/pa/v3/unlinked-templates: + get: + description: This endpoint returns the list of unlinked PA templates. + operationId: getUnlinkedPATemplates parameters: - - description: Unique identifier for a templated PA component - explode: false - in: path - name: id - required: true + - description: Get unlinked PA templates in path. + explode: true + in: query + name: directory + required: false schema: - description: Unique identifier for a templated PA component + description: Get unlinked PA templates in path. type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot' - description: Request Parameters - required: true + style: form + - description: Get unlinked PA templates by category. + explode: true + in: query + name: category + required: false + schema: + description: Get unlinked PA templates by category. + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' - description: Expected response, updated successfully. + $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot' + description: Expected response, returns a list of unlinked PA templates. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -34932,47 +35598,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Component or template not found. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple "401": description: Missing or invalid authentication. headers: @@ -35132,45 +35757,57 @@ paths: available after successful authentication. type: string style: simple - summary: Update templated PA component + summary: Get unlinked PA templates tags: - - TemplatedPAComponents + - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: TemplatedPAComponentPostSummaryRoot - x-contentType: application/json + response-type: UnlinkedPATemplateSummaryRoot x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates: - get: - description: This endpoint returns the list of unlinked PA templates. - operationId: getUnlinkedPATemplates - parameters: - - description: Get unlinked PA templates in path. - explode: true - in: query - name: directory - required: false - schema: - description: Get unlinked PA templates in path. - type: string - style: form - - description: Get unlinked PA templates by category. - explode: true - in: query - name: category - required: false - schema: - description: Get unlinked PA templates by category. - type: string - style: form + post: + description: "This endpoint creates a template which is not linked to any specific\ + \ PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be\ + \ passed in POST requests and Optional fields are not necessary. \r\n If\ + \ no mandatory fields are passed, then we can use the template as a component\ + \ and skip the component creation.\r\n \r\n* Mandatory, optional and\ + \ locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\"\ + , \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\ + .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\ + \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \ + \ Any settings in the POST body will act as a one-time override over the settings\ + \ saved in the PA template.\r\n\r\n* 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 gouping\ + \ frequency without overriding the group id it will not be applied to the\ + \ default groupings saved to the original component." + operationId: createUnlinkedPATemplates + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot' + description: Request Parameters + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot' - description: Expected response, returns a list of unlinked PA templates. + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, created a unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35407,49 +36044,32 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA templates + summary: Create unlinked PA template tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: UnlinkedPATemplateSummaryRoot + - status-code: "201" + response-type: UnlinkedPATemplatePostSummaryRoot + x-contentType: application/json x-accepts: application/json - post: - description: "This endpoint creates a template which is not linked to any specific\ - \ PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be\ - \ passed in POST requests and Optional fields are not necessary. \r\n If\ - \ no mandatory fields are passed, then we can use the template as a component\ - \ and skip the component creation.\r\n \r\n* Mandatory, optional and\ - \ locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\"\ - , \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\ - .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\ - \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \ - \ Any settings in the POST body will act as a one-time override over the settings\ - \ saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\ - \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ - \ and totals as well but if we don't pass anything that defaults to securities.\r\ - \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\ - \ the grouping saved to the original component and also \r\n overriding\ - \ the default frequency of the Beginning of Period to whatever we pass in\ - \ the request body.\r\n \r\n* If we are overriding gouping frequency\ - \ without overriding the group id it will not be applied to the default groupings\ - \ saved to the original component." - operationId: createUnlinkedPATemplates - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot' - description: Request Parameters + /analytics/engines/pa/v3/unlinked-templates/{id}: + delete: + description: This endpoint deletes an existing unliked PA template. + operationId: deleteUnlinkedPATemplates + parameters: + - description: Unique identifier for an unlinked PA template + explode: false + in: path + name: id required: true + schema: + description: Unique identifier for an unlinked PA template + type: string + style: simple responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, created a unlinked PA template. + "204": + description: Expected response, deleted the unlinked PA template successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35527,6 +36147,47 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple "401": description: Missing or invalid authentication. headers: @@ -35686,19 +36347,16 @@ paths: available after successful authentication. type: string style: simple - summary: Create unlinked PA template + summary: Delete unlinked PA template tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "201" - response-type: UnlinkedPATemplatePostSummaryRoot - x-contentType: application/json + - status-code: "204" x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates/{id}: - delete: - description: This endpoint deletes an existing unliked PA template. - operationId: deleteUnlinkedPATemplates + get: + description: This endpoint fetches the template settings. + operationId: getUnlinkedPATemplatesById parameters: - description: Unique identifier for an unlinked PA template explode: false @@ -35710,8 +36368,12 @@ paths: type: string style: simple responses: - "204": - description: Expected response, deleted the unlinked PA template successfully. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateRoot' + description: Expected response, get details of the unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -35989,16 +36651,43 @@ paths: available after successful authentication. type: string style: simple - summary: Delete unlinked PA template + summary: Get unlinked PA template details by id tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: UnlinkedPATemplateRoot x-accepts: application/json - get: - description: This endpoint fetches the template settings. - operationId: getUnlinkedPATemplatesById + put: + description: "This endpoint updates an existing unlinked PA template.\r\n\r\n\ + Remarks:\r\n \r\n* Mandatory fields are required to be passed\ + \ in POST requests and Optional fields are not necessary. \r\n If no mandatory\ + \ fields are passed, then we can use the template as a component and skip\ + \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\ + \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\ + , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\ + \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\ + \ and locked strings are mutually exclusive.\r\n\r\n* Any settings in the\ + \ POST body will act as a one-time override over the settings saved in the\ + \ PA template.\r\n\r\n* 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 gouping frequency\ + \ without overriding the group id it will not be applied to the default groupings\ + \ saved to the original component." + operationId: updateUnlinkedPATemplates parameters: - description: Unique identifier for an unlinked PA template explode: false @@ -36009,13 +36698,20 @@ paths: description: Unique identifier for an unlinked PA template type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot' + description: Request Parameters + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplateRoot' - description: Expected response, get details of the unlinked PA template. + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, updated the unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36293,59 +36989,26 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA template details by id + summary: Update unlinked PA template tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: UnlinkedPATemplateRoot + response-type: UnlinkedPATemplatePostSummaryRoot + x-contentType: application/json x-accepts: application/json - put: - description: "This endpoint updates an existing unlinked PA template.\r\n\r\n\ - Remarks:\r\n \r\n* Mandatory fields are required to be passed\ - \ in POST requests and Optional fields are not necessary. \r\n If no mandatory\ - \ fields are passed, then we can use the template as a component and skip\ - \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\ - \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\ - , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\ - \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\ - \ and locked strings are mutually exclusive.\r\n\r\n* Any settings in the\ - \ POST body will act as a one-time override over the settings saved in the\ - \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\ - \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\ - \ totals as well but if we don't pass anything that defaults to securities.\r\ - \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\ - \ the grouping saved to the original component and also overriding \r\n \ - \ the default frequency of the Beginning of Period to whatever we pass in\ - \ the request body.\r\n \r\n* If we are overriding gouping frequency\ - \ without overriding the group id it will not be applied to the default groupings\ - \ saved to the original component." - operationId: updateUnlinkedPATemplates - parameters: - - description: Unique identifier for an unlinked PA template - explode: false - in: path - name: id - required: true - schema: - description: Unique identifier for an unlinked PA template - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot' - description: Request Parameters - required: true + /analytics/engines/pa/v3/unlinked-templates/template-types: + get: + description: This endpoint fetches default unlinked PA template types. + operationId: getDefaultUnlinkedPATemplateTypes responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' - description: Expected response, updated the unlinked PA template. + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' + description: Expected response, default unlinked PA template types headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36381,13 +37044,27 @@ paths: schema: type: string style: simple - "400": - content: - application/json: + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36423,12 +37100,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Template not found. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36464,8 +37137,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36483,8 +37157,81 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get default unlinked PA template types. + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateCategoryAndTypeRoot + x-accepts: application/json + /analytics/engines/pa/v3/unlinked-templates/template-types/{id}: + get: + description: This endpoint fetches the unlinked PA template type details. + operationId: getDetailsType + parameters: + - description: Unique identifier for an unlinked PA template type + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for an unlinked PA template type + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot' + description: Expected response, details of the unlinked PA template type headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36520,8 +37267,13 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json. + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36557,92 +37309,12 @@ paths: schema: type: string style: simple - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - summary: Update unlinked PA template - tags: - - UnlinkedPATemplates - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: UnlinkedPATemplatePostSummaryRoot - x-contentType: application/json - x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates/template-types: - get: - description: This endpoint fetches default unlinked PA template types. - operationId: getDefaultUnlinkedPATemplateTypes - responses: - "200": + "404": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' - description: Expected response, default unlinked PA template types + $ref: '#/components/schemas/ClientErrorResponse' + description: Unlinked PA template type not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36837,35 +37509,48 @@ paths: available after successful authentication. type: string style: simple - summary: Get default unlinked PA template types. + summary: Get unlinked PA template type details by id. tags: - UnlinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: UnlinkedPATemplateCategoryAndTypeRoot + response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot x-accepts: application/json - /analytics/engines/pa/v3/unlinked-templates/template-types/{id}: - get: - description: This endpoint fetches the unlinked PA template type details. - operationId: getDetailsType + /analytics/engines/vault/v3/load/{batchId}: + post: + description: This endpoint loads Vault External Attributions. + operationId: vaultAttributionLoader parameters: - - description: Unique identifier for an unlinked PA template type - explode: false + - explode: false in: path - name: id + name: batchId required: true schema: - description: Unique identifier for an unlinked PA template type type: string style: simple + requestBody: + $ref: '#/components/requestBodies/inline_object' + content: + multipart/form-data: + encoding: + file: + style: form + schema: + properties: + file: + format: binary + nullable: true + type: string + type: object responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot' - description: Expected response, details of the unlinked PA template type + $ref: '#/components/schemas/VaultAttributionLoaderResponseRoot' + description: Expected response, returns a status of operation along with + errors and warnings if found any. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -36906,49 +37591,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid data provided. Please check the request parameters - before attempting again. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Unlinked PA template type not found. + description: Bad Request headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -37143,13 +37786,14 @@ paths: available after successful authentication. type: string style: simple - summary: Get unlinked PA template type details by id. + summary: Vault - External Attribution Loader tags: - - UnlinkedPATemplates + - Vault Attribution Loader x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot + response-type: VaultAttributionLoaderResponseRoot + x-contentType: multipart/form-data x-accepts: application/json /analytics/engines/vault/v3/calculations: get: @@ -39558,9 +40202,14 @@ paths: response-type: ObjectRoot x-accepts: application/json components: + requestBodies: + inline_object: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/inline_object' schemas: ReturnType: - additionalProperties: false example: name: name id: id @@ -39571,7 +40220,6 @@ components: type: string type: object SPARAccounts: - additionalProperties: false example: returnsType: - name: name @@ -39586,7 +40234,6 @@ components: type: array type: object SPARAccountsRoot: - additionalProperties: false example: data: returnsType: @@ -39604,7 +40251,6 @@ components: - data type: object ErrorSource: - additionalProperties: false example: pointer: pointer parameter: parameter @@ -39615,23 +40261,27 @@ components: type: string type: object Error: - additionalProperties: false 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: - additionalProperties: false properties: errors: items: @@ -39639,7 +40289,6 @@ components: type: array type: object AccountDirectories: - additionalProperties: false example: directories: - directories @@ -39660,7 +40309,6 @@ components: type: array type: object AccountDirectoriesRoot: - additionalProperties: false example: data: directories: @@ -39679,7 +40327,6 @@ components: - data type: object AFIOptimizerStrategyOverrides: - additionalProperties: false example: alpha: alpha tax: tax @@ -39710,7 +40357,6 @@ components: type: string type: object AFIOptimizerStrategy: - additionalProperties: false example: overrides: alpha: alpha @@ -39730,7 +40376,6 @@ components: - id type: object OptimizerAccountOverrides: - additionalProperties: false example: portfolio: portfolio riskModelId: riskModelId @@ -39751,7 +40396,6 @@ components: type: string type: object OptimizerAccount: - additionalProperties: false example: id: id overrides: @@ -39767,7 +40411,6 @@ components: $ref: '#/components/schemas/OptimizerAccountOverrides' type: object Optimization: - additionalProperties: false example: cashflow: cashflow riskModelDate: riskModelDate @@ -39784,7 +40427,6 @@ components: type: string type: object OptimizerTradesList: - additionalProperties: false example: includeCash: true identifierType: Asset @@ -39808,7 +40450,6 @@ components: type: boolean type: object OptimizerOptimalHoldings: - additionalProperties: false example: includeCash: true excludeZero: true @@ -39836,7 +40477,6 @@ components: type: boolean type: object OptimalPortfolio: - additionalProperties: false example: ifOfdbDateExists: abort excludeZero: true @@ -39869,10 +40509,8 @@ components: type: string type: object OptimizerStats: - additionalProperties: false type: object OptimizerOutputTypes: - additionalProperties: false example: optimal: includeCash: true @@ -39896,11 +40534,9 @@ components: account: $ref: '#/components/schemas/OptimalPortfolio' stats: - additionalProperties: false type: object type: object AFIOptimizationParameters: - additionalProperties: false example: optimization: cashflow: cashflow @@ -39951,10 +40587,8 @@ components: - strategy type: object OptimizerCalculationMeta: - additionalProperties: false type: object AFIOptimizationParametersRoot: - additionalProperties: false example: data: optimization: @@ -39997,18 +40631,15 @@ components: data: $ref: '#/components/schemas/AFIOptimizationParameters' meta: - additionalProperties: false type: object type: object CalculationInfo: - additionalProperties: false properties: calculationId: description: Calculation identifier type: string type: object CalculationInfoRoot: - additionalProperties: false properties: data: $ref: '#/components/schemas/CalculationInfo' @@ -40018,7 +40649,6 @@ components: - data type: object ObjectRoot: - additionalProperties: false example: data: '{}' meta: '{}' @@ -40031,7 +40661,6 @@ components: - data type: object AxiomaEquityOptimizerStrategyOverrides: - additionalProperties: false example: alpha: alpha tax: tax @@ -40062,7 +40691,6 @@ components: type: string type: object AxiomaEquityOptimizerStrategy: - additionalProperties: false example: overrides: alpha: alpha @@ -40082,7 +40710,6 @@ components: - id type: object AxiomaEquityOptimizationParameters: - additionalProperties: false example: optimization: cashflow: cashflow @@ -40133,7 +40760,6 @@ components: - strategy type: object AxiomaEquityOptimizationParametersRoot: - additionalProperties: false example: data: optimization: @@ -40176,11 +40802,9 @@ components: data: $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' meta: - additionalProperties: false type: object type: object SPARIdentifier: - additionalProperties: false description: The account/benchmark parameter for SPAR calculation. example: prefix: prefix @@ -40200,7 +40824,6 @@ components: - id type: object SPARBenchmark: - additionalProperties: false example: identifiers: - prefix: prefix @@ -40225,7 +40848,6 @@ components: type: array type: object SPARBenchmarkRoot: - additionalProperties: false example: data: identifiers: @@ -40247,7 +40869,6 @@ components: - data type: object ConstraintAction: - additionalProperties: false example: item2: Disable item1: item1 @@ -40261,7 +40882,6 @@ components: type: string type: object BPMOptimizerStrategyAlphaOverride: - additionalProperties: false example: returnMultiplier: returnMultiplier formula: formula @@ -40281,7 +40901,6 @@ components: type: string type: object BPMOptimizerStrategyOverrides: - additionalProperties: false example: alpha: returnMultiplier: returnMultiplier @@ -40310,7 +40929,6 @@ components: type: string type: object BPMOptimizerStrategy: - additionalProperties: false example: overrides: alpha: @@ -40335,7 +40953,6 @@ components: - id type: object BPMOptimization: - additionalProperties: false example: market: market investAllCash: true @@ -40360,7 +40977,6 @@ components: type: string type: object BPMOptimizationParameters: - additionalProperties: false example: optimization: market: market @@ -40418,7 +41034,6 @@ components: - strategy type: object BPMOptimizationParametersRoot: - additionalProperties: false example: data: optimization: @@ -40468,11 +41083,9 @@ components: data: $ref: '#/components/schemas/BPMOptimizationParameters' meta: - additionalProperties: false type: object type: object ColumnSummary: - additionalProperties: false description: Column settings (name, directory, category) example: name: name @@ -40490,7 +41103,6 @@ components: type: string type: object ColumnSummaryRoot: - additionalProperties: false example: data: key: @@ -40509,7 +41121,6 @@ components: - data type: object Column: - additionalProperties: false example: defaultstatisticsids: - defaultstatisticsids @@ -40534,7 +41145,6 @@ components: type: string type: object ColumnRoot: - additionalProperties: false example: data: defaultstatisticsids: @@ -40553,7 +41163,6 @@ components: - data type: object ColumnStatistic: - additionalProperties: false example: name: name properties: @@ -40562,7 +41171,6 @@ components: type: string type: object ColumnStatisticRoot: - additionalProperties: false example: data: key: @@ -40579,7 +41187,6 @@ components: - data type: object ComponentSummary: - additionalProperties: false example: name: name category: category @@ -40592,7 +41199,6 @@ components: type: string type: object ComponentSummaryRoot: - additionalProperties: false example: data: key: @@ -40610,7 +41216,6 @@ components: - data type: object PAIdentifier: - additionalProperties: false example: id: id holdingsmode: holdingsmode @@ -40625,7 +41230,6 @@ components: - id type: object PADateParameters: - additionalProperties: false description: The date parameters for PA calculation. example: enddate: enddate @@ -40646,7 +41250,6 @@ components: - frequency type: object PAComponent: - additionalProperties: false example: currencyisocode: currencyisocode path: path @@ -40700,7 +41303,6 @@ components: type: string type: object PAComponentRoot: - additionalProperties: false example: data: currencyisocode: currencyisocode @@ -40732,8 +41334,72 @@ components: 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: - additionalProperties: false description: The account/benchmark parameter for Vault calculation. example: id: id @@ -40745,7 +41411,6 @@ components: - id type: object VaultDateParameters: - additionalProperties: false description: The date parameters for Vault calculation example: enddate: enddate @@ -40766,7 +41431,6 @@ components: - frequency type: object VaultComponent: - additionalProperties: false example: currencyisocode: currencyisocode path: path @@ -40809,7 +41473,6 @@ components: type: string type: object VaultComponentRoot: - additionalProperties: false example: data: currencyisocode: currencyisocode @@ -40836,7 +41499,6 @@ components: - data type: object VaultConfigurationSummary: - additionalProperties: false example: name: name properties: @@ -40845,7 +41507,6 @@ components: type: string type: object VaultConfigurationSummaryRoot: - additionalProperties: false example: data: key: @@ -40862,7 +41523,6 @@ components: - data type: object ConfigurationAccount: - additionalProperties: false example: maxEndDate: maxEndDate minStartDate: minStartDate @@ -40891,7 +41551,6 @@ components: type: string type: object VaultConfiguration: - additionalProperties: false example: name: name accounts: @@ -40912,7 +41571,6 @@ components: type: object type: object VaultConfigurationRoot: - additionalProperties: false example: data: name: name @@ -40934,7 +41592,6 @@ components: - data type: object Currency: - additionalProperties: false example: name: name properties: @@ -40943,7 +41600,6 @@ components: type: string type: object CurrencyRoot: - additionalProperties: false example: data: key: @@ -40960,7 +41616,6 @@ components: - data type: object DateParametersSummary: - additionalProperties: false example: enddate: enddate startdate: startdate @@ -40973,7 +41628,6 @@ components: type: string type: object DateParametersSummaryRoot: - additionalProperties: false example: data: enddate: enddate @@ -40988,7 +41642,6 @@ components: - data type: object FIDiscountCurveInfo: - additionalProperties: false example: name: name currency: currency @@ -41002,7 +41655,6 @@ components: type: string type: object FIDiscountCurveInfoRoot: - additionalProperties: false example: data: key: @@ -41021,7 +41673,6 @@ components: - data type: object DocumentDirectories: - additionalProperties: false example: documents: - documents @@ -41042,7 +41693,6 @@ components: type: array type: object DocumentDirectoriesRoot: - additionalProperties: false example: data: documents: @@ -41061,7 +41711,6 @@ components: - data type: object FIABIdentifier: - additionalProperties: false example: id: id properties: @@ -41072,7 +41721,6 @@ components: - id type: object FIABDateParameters: - additionalProperties: false description: The date parameters for FIAB calculations. example: enddate: enddate @@ -41089,7 +41737,6 @@ components: - startdate type: object FIABCalculationParameters: - additionalProperties: false example: fiabdocument: fiabdocument msl: msl @@ -41122,7 +41769,6 @@ components: - dates type: object FIABCalculationStatusSummary: - additionalProperties: false properties: requesttime: description: Request time of calculation. @@ -41134,7 +41780,6 @@ components: type: string type: object EventSummary: - additionalProperties: false example: submissiondatetime: 2000-01-23T04:56:07.000+00:00 message: message @@ -41152,7 +41797,6 @@ components: type: string type: object FIABCalculationStatus: - additionalProperties: false example: completiondatetime: 2000-01-23T04:56:07.000+00:00 batchevents: @@ -41199,7 +41843,6 @@ components: type: array type: object FIReferencePrepay: - additionalProperties: false example: prepayName: prepayName properties: @@ -41208,7 +41851,6 @@ components: type: string type: object FIReferenceSecurity: - additionalProperties: false example: calcFromMethod: calcFromMethod prepay: @@ -41242,7 +41884,6 @@ components: type: string type: object FIBankLoans: - additionalProperties: false example: ignoreSinkingFund: true properties: @@ -41251,7 +41892,6 @@ components: type: boolean type: object FIMunicipalBonds: - additionalProperties: false example: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -41264,7 +41904,6 @@ components: type: boolean type: object FILoss: - additionalProperties: false example: lossName: lossName properties: @@ -41273,7 +41912,6 @@ components: type: string type: object FIPrepay: - additionalProperties: false example: prepayName: prepayName properties: @@ -41282,7 +41920,6 @@ components: type: string type: object FIServicerAdvancesForSecurities: - additionalProperties: false example: principal: 5.962133916683182 interest: 5.637376656633329 @@ -41307,7 +41944,6 @@ components: type: string type: object FIPrepayLockout: - additionalProperties: false example: pointsAbove: ANY ymAbove: ANY @@ -41328,7 +41964,6 @@ components: type: string type: object FICashflows: - additionalProperties: false example: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 @@ -41354,7 +41989,6 @@ components: type: integer type: object FIBalloonExtension: - additionalProperties: false example: months: 9 percentage: 3.616076749251911 @@ -41386,7 +42020,6 @@ components: type: number type: object FIStructuredProductsForSecurities: - additionalProperties: false example: balloonExtension: months: 9 @@ -41427,14 +42060,46 @@ components: 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: + 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 FISecurity: - additionalProperties: false example: callMethod: No Call symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 4.145608029883936 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -41473,10 +42138,16 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 7.386281948385884 + 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 properties: settlement: @@ -41510,6 +42181,8 @@ components: 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\ @@ -41544,7 +42217,6 @@ components: - symbol type: object FIMunicipalBondsForJobSettings: - additionalProperties: false example: useAnticipatedSinkSchedule: true ignoreSinkingFund: true @@ -41561,7 +42233,6 @@ components: type: boolean type: object FIMarketEnvironment: - additionalProperties: false example: ratePath: FLAT & FORWARD properties: @@ -41575,7 +42246,6 @@ components: type: string type: object FIServicerAdvances: - additionalProperties: false example: advanceType: Advances All properties: @@ -41590,7 +42260,6 @@ components: type: string type: object FIStructuredProductsForJobSettings: - additionalProperties: false example: balloonExtension: months: 9 @@ -41629,8 +42298,19 @@ components: balloonExtension: $ref: '#/components/schemas/FIBalloonExtension' type: object + FIAttributionForJobSettings: + example: + endDate: endDate + startDate: startDate + properties: + startDate: + description: Start Date + type: string + endDate: + description: End Date + type: string + type: object FIJobSettings: - additionalProperties: false example: callMethod: No Call calcFromMethod: calcFromMethod @@ -41657,14 +42337,17 @@ components: useAnticipatedSinkSchedule: true ignoreSinkingFund: true allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate marketEnvironment: ratePath: FLAT & FORWARD asOfDate: asOfDate bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 1 - - 1 + - 7 + - 7 settlement: settlement properties: asOfDate: @@ -41702,11 +42385,12 @@ components: $ref: '#/components/schemas/FIMarketEnvironment' structuredProducts: $ref: '#/components/schemas/FIStructuredProductsForJobSettings' + attribution: + $ref: '#/components/schemas/FIAttributionForJobSettings' required: - asOfDate type: object FICalculationParameters: - additionalProperties: false example: jobSettings: callMethod: No Call @@ -41734,14 +42418,17 @@ components: useAnticipatedSinkSchedule: true ignoreSinkingFund: true allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate marketEnvironment: ratePath: FLAT & FORWARD asOfDate: asOfDate bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 1 - - 1 + - 7 + - 7 settlement: settlement calculations: - calculations @@ -41751,7 +42438,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 4.145608029883936 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -41790,16 +42477,22 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 7.386281948385884 + 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: 4.145608029883936 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -41838,10 +42531,16 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 7.386281948385884 + 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 properties: securities: @@ -41862,7 +42561,6 @@ components: - securities type: object CalculationMeta: - additionalProperties: false example: contentorganization: SimplifiedRow format: JsonStach @@ -41908,7 +42606,6 @@ components: type: string type: object FICalculationParametersRoot: - additionalProperties: false example: data: jobSettings: @@ -41937,14 +42634,17 @@ components: useAnticipatedSinkSchedule: true ignoreSinkingFund: true allowSinkForInstallmentPayment: true + attribution: + endDate: endDate + startDate: startDate marketEnvironment: ratePath: FLAT & FORWARD asOfDate: asOfDate bankLoans: ignoreSinkingFund: true partialDurationMonths: - - 1 - - 1 + - 7 + - 7 settlement: settlement calculations: - calculations @@ -41954,7 +42654,7 @@ components: symbol: symbol matrixMultiplier: 1.4658129805029452 discountCurve: discountCurve - calcFromValue: 4.145608029883936 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -41993,16 +42693,22 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 7.386281948385884 + 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: 4.145608029883936 + calcFromValue: 1.4894159098541704 bankLoans: ignoreSinkingFund: true faceType: Current @@ -42041,10 +42747,16 @@ components: optionalRedemptionCallWhenUnits: Manual optionalRedemptionCallWhen: 2 recoveryLag: 7 - face: 7.386281948385884 + 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 meta: contentorganization: SimplifiedRow @@ -42058,7 +42770,6 @@ components: $ref: '#/components/schemas/CalculationMeta' type: object PaDoc: - additionalProperties: false example: id: id properties: @@ -42069,7 +42780,6 @@ components: - id type: object FPOAccount: - additionalProperties: false example: paDocument: id: id @@ -42091,7 +42801,6 @@ components: - paDocument type: object FPOObjective: - additionalProperties: false example: terms: key: Disable @@ -42108,7 +42817,6 @@ components: type: object type: object FPOOptimizerStrategyOverrides: - additionalProperties: false example: alpha: alpha transactionCost: transactionCost @@ -42137,7 +42845,6 @@ components: type: string type: object FPOOptimizerStrategy: - additionalProperties: false example: overrides: alpha: alpha @@ -42159,7 +42866,6 @@ components: - id type: object FPOOptimizationParameters: - additionalProperties: false example: optimization: cashflow: cashflow @@ -42214,7 +42920,6 @@ components: - strategy type: object FPOOptimizationParametersRoot: - additionalProperties: false example: data: optimization: @@ -42261,11 +42966,9 @@ components: data: $ref: '#/components/schemas/FPOOptimizationParameters' meta: - additionalProperties: false type: object type: object Frequency: - additionalProperties: false example: name: name properties: @@ -42274,7 +42977,6 @@ components: type: string type: object FrequencyRoot: - additionalProperties: false example: data: key: @@ -42291,7 +42993,6 @@ components: - data type: object Group: - additionalProperties: false example: name: name category: category @@ -42308,7 +43009,6 @@ components: type: string type: object GroupRoot: - additionalProperties: false example: data: key: @@ -42327,7 +43027,6 @@ components: - data type: object TemplateContentTypes: - additionalProperties: false example: optional: - optional @@ -42356,7 +43055,6 @@ components: type: array type: object LinkedPATemplateParameters: - additionalProperties: false example: parentComponentId: parentComponentId description: description @@ -42388,7 +43086,6 @@ components: - parentComponentId type: object LinkedPATemplateParametersRoot: - additionalProperties: false example: data: parentComponentId: parentComponentId @@ -42414,7 +43111,6 @@ components: - data type: object LinkedPATemplatePostSummary: - additionalProperties: false example: parentComponentId: parentComponentId name: name @@ -42435,7 +43131,6 @@ components: type: string type: object LinkedPATemplatePostSummaryRoot: - additionalProperties: false example: data: parentComponentId: parentComponentId @@ -42452,7 +43147,6 @@ components: - data type: object LinkedPATemplateSummary: - additionalProperties: false example: parentComponentId: parentComponentId name: name @@ -42469,7 +43163,6 @@ components: type: string type: object LinkedPATemplateSummaryRoot: - additionalProperties: false example: data: key: @@ -42488,7 +43181,6 @@ components: - data type: object LinkedPATemplateUpdateParameters: - additionalProperties: false example: parentComponentId: parentComponentId description: description @@ -42513,7 +43205,6 @@ components: $ref: '#/components/schemas/TemplateContentTypes' type: object LinkedPATemplateUpdateParametersRoot: - additionalProperties: false example: data: parentComponentId: parentComponentId @@ -42538,7 +43229,6 @@ components: - data type: object LinkedPATemplate: - additionalProperties: false example: parentComponentId: parentComponentId name: name @@ -42579,7 +43269,6 @@ components: type: string type: object LinkedPATemplateRoot: - additionalProperties: false example: data: parentComponentId: parentComponentId @@ -42608,7 +43297,6 @@ components: - data type: object NPOOptimizerStrategyOverrides: - additionalProperties: false example: alpha: alpha tax: tax @@ -42642,7 +43330,6 @@ components: type: string type: object NPOOptimizerStrategy: - additionalProperties: false example: overrides: alpha: alpha @@ -42666,7 +43353,6 @@ components: - id type: object NPOOptimizationParameters: - additionalProperties: false example: optimization: cashflow: cashflow @@ -42721,7 +43407,6 @@ components: - strategy type: object NPOOptimizationParametersRoot: - additionalProperties: false example: data: optimization: @@ -42768,11 +43453,9 @@ components: data: $ref: '#/components/schemas/NPOOptimizationParameters' meta: - additionalProperties: false type: object type: object PACalculationGroup: - additionalProperties: false example: id: id frequency: frequency @@ -42785,7 +43468,6 @@ components: type: string type: object PACalculationColumn: - additionalProperties: false example: id: id statistics: @@ -42802,7 +43484,6 @@ components: type: array type: object PACalculationPricingSource: - additionalProperties: false example: id: id properties: @@ -42811,7 +43492,6 @@ components: type: string type: object PACalculationDataSources: - additionalProperties: false example: benchmarkpricingsources: - id: id @@ -42836,7 +43516,6 @@ components: type: boolean type: object PACalculationParameters: - additionalProperties: false example: currencyisocode: currencyisocode componentdetail: componentdetail @@ -42918,7 +43597,6 @@ components: - componentid type: object PACalculationParametersRoot: - additionalProperties: false example: data: key: @@ -42976,21 +43654,27 @@ components: $ref: '#/components/schemas/CalculationMeta' type: object CalculationUnitStatus: - additionalProperties: false example: result: result + warnings: + - warnings + - warnings progress: progress errors: - - id: id + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter - - id: id + title: title + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter + title: title status: Queued points: 0 properties: @@ -43018,26 +43702,37 @@ components: description: The points for the calculation unit. format: int32 type: integer + warnings: + description: The warnings in a calculation unit. + items: + type: string + type: array type: object CalculationStatus: - additionalProperties: false example: calculationid: calculationid units: key: result: result + warnings: + - warnings + - warnings progress: progress errors: - - id: id + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter - - id: id + title: title + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter + title: title status: Queued points: 0 status: Queued @@ -43060,7 +43755,6 @@ components: type: object type: object CalculationUnitStatusMeta: - additionalProperties: false example: info: info properties: @@ -43069,7 +43763,6 @@ components: type: string type: object CalculationStatusMeta: - additionalProperties: false example: units: key: @@ -43082,25 +43775,31 @@ components: type: object type: object CalculationStatusRoot: - additionalProperties: false example: data: calculationid: calculationid units: key: result: result + warnings: + - warnings + - warnings progress: progress errors: - - id: id + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter - - id: id + title: title + - code: code + id: id detail: detail source: pointer: pointer parameter: parameter + title: title status: Queued points: 0 status: Queued @@ -43117,7 +43816,6 @@ components: - data type: object CalculationsSummary: - additionalProperties: false example: requestTime: 2000-01-23T04:56:07.000+00:00 lastPollTime: 2000-01-23T04:56:07.000+00:00 @@ -43146,7 +43844,6 @@ components: type: string type: object PaginationInfo: - additionalProperties: false example: pageNumber: 6 previousPage: previousPage @@ -43173,7 +43870,6 @@ components: type: string type: object PaginationMeta: - additionalProperties: false example: pagination: pageNumber: 6 @@ -43187,7 +43883,6 @@ components: $ref: '#/components/schemas/PaginationInfo' type: object CalculationsSummaryRoot: - additionalProperties: false example: data: requestTime: 2000-01-23T04:56:07.000+00:00 @@ -43211,7 +43906,6 @@ components: - data type: object PAPricingSource: - additionalProperties: false example: name: name category: category @@ -43228,7 +43922,6 @@ components: type: string type: object PAPricingSourceRoot: - additionalProperties: false example: data: key: @@ -43247,7 +43940,6 @@ components: - data type: object PubIdentifier: - additionalProperties: false example: id: id holdingsmode: holdingsmode @@ -43262,7 +43954,6 @@ components: - id type: object PubDateParameters: - additionalProperties: false description: The date parameters for Publisher calculation. example: enddate: enddate @@ -43278,7 +43969,6 @@ components: - enddate type: object PubCalculationParameters: - additionalProperties: false example: document: document dates: @@ -43301,10 +43991,8 @@ components: - document type: object PubCalculationMeta: - additionalProperties: false type: object PubCalculationParametersRoot: - additionalProperties: false example: data: key: @@ -43323,11 +44011,9 @@ components: description: List of calculation parameters. type: object meta: - additionalProperties: false type: object type: object QuantScreeningExpressionUniverse: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantUniverse' properties: @@ -43345,7 +44031,6 @@ components: - universeType type: object QuantIdentifierUniverse: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantUniverse' properties: @@ -43363,7 +44048,6 @@ components: - universeType type: object QuantUniverse: - additionalProperties: false properties: source: enum: @@ -43375,7 +44059,6 @@ components: - source type: object QuantUniversalScreenUniverse: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantUniverse' properties: @@ -43385,7 +44068,6 @@ components: - screen type: object QuantDateList: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantDate' properties: @@ -43395,7 +44077,6 @@ components: type: array type: object QuantDate: - additionalProperties: false properties: source: enum: @@ -43414,7 +44095,6 @@ components: - source type: object QuantFdsDate: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantDate' properties: @@ -43427,7 +44107,6 @@ components: - startDate type: object QuantFqlExpression: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantFormula' properties: @@ -43444,7 +44123,6 @@ components: - name type: object QuantUniversalScreenParameter: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantFormula' properties: @@ -43457,12 +44135,10 @@ components: - referenceName type: object QuantAllUniversalScreenParameters: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantFormula' type: object QuantFormula: - additionalProperties: false properties: source: enum: @@ -43475,7 +44151,6 @@ components: - source type: object QuantScreeningExpression: - additionalProperties: false allOf: - $ref: '#/components/schemas/QuantFormula' properties: @@ -43490,7 +44165,6 @@ components: - name type: object QuantScreeningExpressionUniverseObsolete: - additionalProperties: false properties: universeExpr: type: string @@ -43512,7 +44186,6 @@ components: - universeType type: object QuantUniversalScreenUniverseObsolete: - additionalProperties: false properties: screen: type: string @@ -43526,7 +44199,6 @@ components: - screen type: object QuantIdentifierUniverseObsolete: - additionalProperties: false properties: universeType: enum: @@ -43548,7 +44220,6 @@ components: - universeType type: object QuantFdsDateObsolete: - additionalProperties: false properties: startDate: type: string @@ -43567,7 +44238,6 @@ components: - startDate type: object QuantDateListObsolete: - additionalProperties: false properties: dates: items: @@ -43584,7 +44254,6 @@ components: - frequency type: object QuantScreeningExpressionObsolete: - additionalProperties: false properties: expr: type: string @@ -43597,7 +44266,6 @@ components: - name type: object QuantFqlExpressionObsolete: - additionalProperties: false properties: expr: type: string @@ -43612,7 +44280,6 @@ components: - name type: object QuantUniversalScreenParameterObsolete: - additionalProperties: false properties: referenceName: type: string @@ -43623,7 +44290,6 @@ components: - referenceName type: object QuantAllUniversalScreenParametersObsolete: - additionalProperties: false type: object OneOfQuantUniverse: discriminator: @@ -43663,7 +44329,6 @@ components: $ref: '#/components/schemas/OneOfQuantFormulas' type: array QuantCalculationParameters: - additionalProperties: false example: formulas: - null @@ -43682,7 +44347,6 @@ components: type: string type: object QuantCalculationMeta: - additionalProperties: false example: contentorganization: SimplifiedRow allowArrayData: true @@ -43731,7 +44395,6 @@ components: type: string type: object QuantCalculationParametersRoot: - additionalProperties: false example: data: key: @@ -43755,7 +44418,6 @@ components: $ref: '#/components/schemas/QuantCalculationMeta' type: object SPARDateParameters: - additionalProperties: false description: The date parameters for SPAR calculation. example: enddate: enddate @@ -43777,7 +44439,6 @@ components: - startdate type: object SPARCalculationParameters: - additionalProperties: false example: currencyisocode: currencyisocode componentid: componentid @@ -43816,7 +44477,6 @@ components: - componentid type: object SPARCalculationParametersRoot: - additionalProperties: false example: data: key: @@ -43852,7 +44512,6 @@ components: $ref: '#/components/schemas/CalculationMeta' type: object PAComponentData: - additionalProperties: false example: currencyisocode: currencyisocode componentdetail: componentdetail @@ -43923,11 +44582,11 @@ components: description: Currency ISO code for calculation. type: string componentdetail: - description: PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + description: PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string type: object TemplatedPAComponentParameters: - additionalProperties: false example: parentTemplateId: parentTemplateId description: description @@ -43988,7 +44647,6 @@ components: - parentTemplateId type: object TemplatedPAComponentParametersRoot: - additionalProperties: false example: data: parentTemplateId: parentTemplateId @@ -44043,7 +44701,6 @@ components: - data type: object TemplatedPAComponentPostSummary: - additionalProperties: false example: parentTemplateId: parentTemplateId name: name @@ -44063,7 +44720,6 @@ components: type: string type: object TemplatedPAComponentPostSummaryRoot: - additionalProperties: false example: data: parentTemplateId: parentTemplateId @@ -44081,7 +44737,6 @@ components: - data type: object TemplatedPAComponentSummary: - additionalProperties: false example: parentTemplateId: parentTemplateId name: name @@ -44098,7 +44753,6 @@ components: type: string type: object TemplatedPAComponentSummaryRoot: - additionalProperties: false example: data: key: @@ -44118,7 +44772,6 @@ components: - data type: object TemplatedPAComponentUpdateParameters: - additionalProperties: false example: parentTemplateId: parentTemplateId description: description @@ -44172,7 +44825,6 @@ components: $ref: '#/components/schemas/PAComponentData' type: object TemplatedPAComponentUpdateParametersRoot: - additionalProperties: false example: data: parentTemplateId: parentTemplateId @@ -44226,7 +44878,6 @@ components: - data type: object TemplatedPAComponent: - additionalProperties: false example: parentTemplateId: parentTemplateId name: name @@ -44293,7 +44944,6 @@ components: type: string type: object TemplatedPAComponentRoot: - additionalProperties: false example: data: parentTemplateId: parentTemplateId @@ -44352,7 +45002,6 @@ components: - data type: object UnlinkedPATemplateParameters: - additionalProperties: false example: templateTypeId: templateTypeId currencyisocode: currencyisocode @@ -44443,7 +45092,8 @@ components: description: Currency ISO code for calculation. type: string componentdetail: - description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string content: $ref: '#/components/schemas/TemplateContentTypes' @@ -44452,7 +45102,6 @@ components: - templateTypeId type: object UnlinkedPATemplateParametersRoot: - additionalProperties: false example: data: templateTypeId: templateTypeId @@ -44516,7 +45165,6 @@ components: - data type: object UnlinkedPATemplatePostSummary: - additionalProperties: false example: name: name description: description @@ -44537,7 +45185,6 @@ components: type: string type: object UnlinkedPATemplatePostSummaryRoot: - additionalProperties: false example: data: name: name @@ -44554,7 +45201,6 @@ components: - data type: object UnlinkedPATemplateSummary: - additionalProperties: false example: name: name description: description @@ -44571,7 +45217,6 @@ components: type: string type: object UnlinkedPATemplateSummaryRoot: - additionalProperties: false example: data: key: @@ -44590,7 +45235,6 @@ components: - data type: object UnlinkedPATemplateUpdateParameters: - additionalProperties: false example: currencyisocode: currencyisocode componentdetail: componentdetail @@ -44673,13 +45317,13 @@ components: description: Currency ISO code for calculation. type: string componentdetail: - description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string content: $ref: '#/components/schemas/TemplateContentTypes' type: object UnlinkedPATemplateUpdateParametersRoot: - additionalProperties: false example: data: currencyisocode: currencyisocode @@ -44741,7 +45385,6 @@ components: - data type: object UnlinkedPATemplate: - additionalProperties: false example: columns: - id: id @@ -44839,7 +45482,8 @@ components: description: Currency ISO code for calculation. type: string componentdetail: - description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. + description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or + SECURITIES. type: string content: $ref: '#/components/schemas/TemplateContentTypes' @@ -44854,7 +45498,6 @@ components: type: string type: object UnlinkedPATemplateRoot: - additionalProperties: false example: data: columns: @@ -44922,7 +45565,6 @@ components: - data type: object UnlinkedPATemplateCategoryAndType: - additionalProperties: false example: name: name category: category @@ -44935,7 +45577,6 @@ components: type: string type: object UnlinkedPATemplateCategoryAndTypeRoot: - additionalProperties: false example: data: key: @@ -44953,7 +45594,6 @@ components: - data type: object UnlinkedPATemplateColumnDetails: - additionalProperties: false example: name: name id: id @@ -44974,7 +45614,6 @@ components: type: array type: object UnlinkedPATemplateGroupDetails: - additionalProperties: false example: name: name id: id @@ -44991,7 +45630,6 @@ components: type: string type: object UnlinkedPATemplateCategoryAndTypeDetails: - additionalProperties: false example: columns: - name: name @@ -45040,7 +45678,6 @@ components: type: string type: object UnlinkedPATemplateCategoryAndTypeDetailsRoot: - additionalProperties: false example: data: columns: @@ -45074,8 +45711,38 @@ components: required: - data type: object + VaultAttributionLoaderResponse: + example: + processId: processId + groupId: groupId + objectId: objectId + properties: + processId: + description: ProcessId. + type: string + groupId: + description: GroupId. + type: string + objectId: + description: ObjectId. + type: string + type: object + VaultAttributionLoaderResponseRoot: + example: + data: + processId: processId + groupId: groupId + objectId: objectId + meta: '{}' + properties: + data: + $ref: '#/components/schemas/VaultAttributionLoaderResponse' + meta: + type: object + required: + - data + type: object VaultCalculationParameters: - additionalProperties: false example: componentdetail: componentdetail componentid: componentid @@ -45107,7 +45774,6 @@ components: - configid type: object VaultCalculationParametersRoot: - additionalProperties: false example: data: key: @@ -45134,6 +45800,13 @@ components: meta: $ref: '#/components/schemas/CalculationMeta' type: object + inline_object: + properties: + file: + format: binary + nullable: true + type: string + type: object securitySchemes: Basic: description: Input your username and password to access this API diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index adfd1dcc..bdb23f1b 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **result** | **String** | The result URL of the calculation. | [optional] **progress** | **String** | The progress of the calculation unit. | [optional] **points** | **Integer** | The points for the calculation unit. | [optional] +**warnings** | **java.util.List<String>** | The warnings in a calculation unit. | [optional] diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index 5cd705b2..d2131975 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -7,6 +7,7 @@ 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 [**getVaultComponents**](ComponentsApi.md#getVaultComponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components @@ -179,6 +180,89 @@ 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.
| +## getSPARComponentById + +> SPARComponentRoot getSPARComponentById(id) + +Get SPAR component by id + +This endpoint returns the default settings of a SPAR 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 = "id_example"; // String | Unique identifier for a SPAR component + try { + SPARComponentRoot result = apiInstance.getSPARComponentById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ComponentsApi#getSPARComponentById"); + 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 SPAR component | + +### Return type + +[**SPARComponentRoot**](SPARComponentRoot.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 SPAR 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 SPAR 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.
| + + ## getSPARComponents > ComponentSummaryRoot getSPARComponents(document) diff --git a/auto-generated-sdk/docs/Error.md b/auto-generated-sdk/docs/Error.md index c561e6c6..6cd9eab3 100644 --- a/auto-generated-sdk/docs/Error.md +++ b/auto-generated-sdk/docs/Error.md @@ -8,6 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | [optional] +**code** | **String** | | [optional] +**title** | **String** | | [optional] **detail** | **String** | | [optional] **source** | [**ErrorSource**](ErrorSource.md) | | [optional] diff --git a/auto-generated-sdk/docs/FIAttributionForJobSettings.md b/auto-generated-sdk/docs/FIAttributionForJobSettings.md new file mode 100644 index 00000000..84583d8a --- /dev/null +++ b/auto-generated-sdk/docs/FIAttributionForJobSettings.md @@ -0,0 +1,18 @@ + + +# FIAttributionForJobSettings + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startDate** | **String** | Start Date | [optional] +**endDate** | **String** | End Date | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FIAttributionForSecurities.md b/auto-generated-sdk/docs/FIAttributionForSecurities.md new file mode 100644 index 00000000..1f999acc --- /dev/null +++ b/auto-generated-sdk/docs/FIAttributionForSecurities.md @@ -0,0 +1,32 @@ + + +# FIAttributionForSecurities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startPrice** | **Double** | Start Price | [optional] +**endPrice** | **Double** | End Price | [optional] +**startSpread** | **Double** | Start Spread | [optional] +**endSpread** | **Double** | End Spread | [optional] +**pricingMethod** | [**PricingMethodEnum**](#PricingMethodEnum) | Pricing Method | [optional] + + + +## Enum: PricingMethodEnum + +Name | Value +---- | ----- +INPUTTED_PRICE | "Inputted Price" +PRICING_MATRIX | "Pricing Matrix" +ACTUAL_SPREAD | "Actual Spread" +OAS | "OAS" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FIJobSettings.md b/auto-generated-sdk/docs/FIJobSettings.md index b5aa2f68..f1df1b9a 100644 --- a/auto-generated-sdk/docs/FIJobSettings.md +++ b/auto-generated-sdk/docs/FIJobSettings.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **municipalBonds** | [**FIMunicipalBondsForJobSettings**](FIMunicipalBondsForJobSettings.md) | | [optional] **marketEnvironment** | [**FIMarketEnvironment**](FIMarketEnvironment.md) | | [optional] **structuredProducts** | [**FIStructuredProductsForJobSettings**](FIStructuredProductsForJobSettings.md) | | [optional] +**attribution** | [**FIAttributionForJobSettings**](FIAttributionForJobSettings.md) | | [optional] diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index f22d8675..2f3695fb 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **matrixSpreadAdjustment** | **Double** | Matrix Spread Adjustment | [optional] **matrixMultiplier** | **Double** | Matrix Multiplier | [optional] **structuredProducts** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] +**attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.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/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md index 74f9cf05..45f35d8e 100644 --- a/auto-generated-sdk/docs/PAComponentData.md +++ b/auto-generated-sdk/docs/PAComponentData.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **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 TOTALS or SECURITIES. | [optional] +**componentdetail** | **String** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/PaCalculationsApi.md b/auto-generated-sdk/docs/PaCalculationsApi.md index 7210ff0b..fd0fc441 100644 --- a/auto-generated-sdk/docs/PaCalculationsApi.md +++ b/auto-generated-sdk/docs/PaCalculationsApi.md @@ -440,11 +440,19 @@ 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 gouping 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 @@ -539,11 +547,19 @@ 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 gouping 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 diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index 4e55b5b6..4acd5a16 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -413,16 +413,16 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json, application/x-protobuf, application/octet-stream +- **Accept**: application/octet-stream, 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.
| | **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.
| @@ -497,16 +497,16 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json, application/x-protobuf, application/octet-stream +- **Accept**: application/octet-stream, application/json ### 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.
| +| **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.
| @@ -572,7 +572,7 @@ Name | Type | Description | Notes ### Return type -(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) +(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -581,18 +581,19 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/json, application/x-protobuf +- **Accept**: application/json, application/octet-stream ### 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.
| +| **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.
| +| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **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.
| @@ -662,7 +663,7 @@ Name | Type | Description | Notes ### Return type -(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) +(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -671,19 +672,20 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json -- **Accept**: application/json, application/x-protobuf +- **Accept**: application/json, application/octet-stream ### 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.
| -| **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.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **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.
| diff --git a/auto-generated-sdk/docs/SPARComponent.md b/auto-generated-sdk/docs/SPARComponent.md new file mode 100644 index 00000000..3701a83f --- /dev/null +++ b/auto-generated-sdk/docs/SPARComponent.md @@ -0,0 +1,23 @@ + + +# SPARComponent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Component identifier. | [optional] +**accounts** | [**java.util.List<SPARIdentifier>**](SPARIdentifier.md) | List of accounts in SPAR document. | [optional] +**benchmarks** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional] +**currencyIsoCode** | **String** | CurrencyCode in SPAR document. | [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/SPARComponentRoot.md b/auto-generated-sdk/docs/SPARComponentRoot.md new file mode 100644 index 00000000..c83b4f71 --- /dev/null +++ b/auto-generated-sdk/docs/SPARComponentRoot.md @@ -0,0 +1,17 @@ + + +# SPARComponentRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SPARComponent**](SPARComponent.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md index dd7a5219..f8510215 100644 --- a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md +++ b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md @@ -25,9 +25,15 @@ 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, and totals as well but if we don't pass anything that defaults to securities. +* 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. @@ -368,9 +374,15 @@ 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, and totals as well but if we don't pass anything that defaults to securities. +* 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. diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md index 7e2e2345..6373dde5 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplate.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplate.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **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 TOTALS or SECURITIES. | [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] diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md index 93c237bb..6565a410 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **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 TOTALS or SECURITIES. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md index 4f3544c6..f4cd57b9 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **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 TOTALS or SECURITIES. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] diff --git a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md index 330700cb..c1d478a9 100644 --- a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md +++ b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md @@ -36,9 +36,15 @@ 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, and totals as well but if we don't pass anything that defaults to securities. +* 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. @@ -549,9 +555,15 @@ 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, and totals as well but if we don't pass anything that defaults to securities. +* 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. diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md new file mode 100644 index 00000000..9d588e13 --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md @@ -0,0 +1,95 @@ + +# 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 new file mode 100644 index 00000000..c4889bd9 --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md @@ -0,0 +1,19 @@ + + +# VaultAttributionLoaderResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processId** | **String** | ProcessId. | [optional] +**groupId** | **String** | GroupId. | [optional] +**objectId** | **String** | ObjectId. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md new file mode 100644 index 00000000..5cc5749f --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md @@ -0,0 +1,18 @@ + + +# VaultAttributionLoaderResponseRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java index acc63f18..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 @@ -17,6 +17,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; @javax.annotation.Generated(value = "CustomJavaClientCodegen") @@ -226,6 +227,95 @@ public ApiResponse getPAComponentsWithHttpInfo(String docu localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } + /** + * Get SPAR component by id + * This endpoint returns the default settings of a SPAR component. + * @param id Unique identifier for a SPAR component (required) + @return SPARComponentRoot + * @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 SPAR 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 SPAR 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 SPARComponentRoot getSPARComponentById(String id) throws ApiException { + return getSPARComponentByIdWithHttpInfo(id).getData(); + } + + /** + * Get SPAR component by id + * This endpoint returns the default settings of a SPAR component. + * @param id Unique identifier for a SPAR component (required) + * @return ApiResponse<SPARComponentRoot> + * @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 SPAR 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 SPAR 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 getSPARComponentByIdWithHttpInfo(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 getSPARComponentById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/spar/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.getSPARComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } /** * Get SPAR components * This endpoint returns the list of SPAR components in a given SPAR document. 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 333aa2f9..59aa9682 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 @@ -487,7 +487,7 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String i } /** * 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. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param paCalculationParametersRoot Calculation Parameters (optional) @@ -515,7 +515,7 @@ public Object postAndCalculate(Integer xFactSetApiLongRunningDeadline, String ca /** * 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. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) * @param paCalculationParametersRoot Calculation Parameters (optional) @@ -584,7 +584,7 @@ public ApiResponse postAndCalculateWithHttpInfo(Integer xFactSetApiLongR } /** * 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. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) @@ -614,7 +614,7 @@ public Object putAndCalculate(String id, Integer xFactSetApiLongRunningDeadline, /** * 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. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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. (optional) * @param cacheControl Standard HTTP header. Accepts max-stale. (optional) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java index 3bbd19ff..cc9b4d78 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 @@ -18,7 +18,6 @@ import factset.analyticsapi.engines.models.CalculationsSummaryRoot; import factset.analyticsapi.engines.models.ClientErrorResponse; import java.io.File; -import factset.analyticsapi.engines.models.ObjectRoot; import factset.analyticsapi.engines.models.QuantCalculationParametersRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") @@ -405,9 +404,9 @@ public ApiResponse getCalculationStatusByIdWithHttpInfo(S 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.
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.
@@ -428,9 +427,9 @@ public File getCalculationUnitInfoById(String id, String unitId) throws ApiExcep 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.
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.
@@ -464,7 +463,7 @@ public ApiResponse getCalculationUnitInfoByIdWithHttpInfo(String id, Strin final String[] localVarAccepts = { - "application/json", "application/x-protobuf", "application/octet-stream" + "application/octet-stream", "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -498,9 +497,9 @@ public ApiResponse getCalculationUnitInfoByIdWithHttpInfo(String id, Strin 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.
+ 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.
@@ -521,9 +520,9 @@ public File getCalculationUnitResultById(String id, String unitId) throws ApiExc 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.
+ 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.
@@ -557,7 +556,7 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str final String[] localVarAccepts = { - "application/json", "application/x-protobuf", "application/octet-stream" + "application/octet-stream", "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -584,18 +583,19 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str * This endpoint runs the Quant Engine calculation specified in the POST body parameters. It can take one or more calculation units as input. * @param cacheControl Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) * @param quantCalculationParametersRoot (optional) - @return (For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) + @return (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) * @throws ApiException if fails to make API call * @http.response.details - - + + - + + @@ -611,18 +611,19 @@ public Object postAndCalculate(String cacheControl, QuantCalculationParametersRo * This endpoint runs the Quant Engine calculation specified in the POST body parameters. It can take one or more calculation units as input. * @param cacheControl Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) * @param quantCalculationParametersRoot (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) + * @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.
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.
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.
413 Request body too large * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
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.
- - + + - + + @@ -648,7 +649,7 @@ public ApiResponse postAndCalculateWithHttpInfo(String cacheControl, Qua final String[] localVarAccepts = { - "application/json", "application/x-protobuf" + "application/json", "application/octet-stream" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -662,11 +663,12 @@ public ApiResponse postAndCalculateWithHttpInfo(String cacheControl, Qua 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(201, new GenericType(){}); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); + returnTypeMap.put(413, new GenericType(){}); return apiClient.invokeAPIWithReturnMap("QuantCalculationsApi.postAndCalculate", localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, @@ -678,19 +680,20 @@ public ApiResponse postAndCalculateWithHttpInfo(String cacheControl, Qua * @param id from url, provided from the location header in the Create and Run Quant Engine calculation endpoint (required) * @param cacheControl Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) * @param quantCalculationParametersRoot Calculation Parameters (optional) - @return (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) + @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.
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.
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.
413 Request body too large * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
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.
- + - - + + + @@ -707,19 +710,20 @@ public Object putAndCalculate(String id, String cacheControl, QuantCalculationPa * @param id from url, provided from the location header in the Create and Run Quant Engine calculation endpoint (required) * @param cacheControl Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) * @param quantCalculationParametersRoot Calculation Parameters (optional) - * @return ApiResponse<Object>(For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) + * @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.
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.
404 One or more calculation settings were unavailable. * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
409 Duplicate calculation exists with same parameters. * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
413 Request body too large * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
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.
- + - - + + + @@ -751,7 +755,7 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, String cacheCo final String[] localVarAccepts = { - "application/json", "application/x-protobuf" + "application/json", "application/octet-stream" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); @@ -765,12 +769,13 @@ public ApiResponse putAndCalculateWithHttpInfo(String id, String cacheCo 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(201, new GenericType(){}); + returnTypeMap.put(202, new GenericType(){}); returnTypeMap.put(400, new GenericType(){}); returnTypeMap.put(404, new GenericType(){}); returnTypeMap.put(409, new GenericType(){}); + returnTypeMap.put(413, new GenericType(){}); return apiClient.invokeAPIWithReturnMap("QuantCalculationsApi.putAndCalculate", localVarPath, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, 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 801b5584..928eb323 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 @@ -52,7 +52,7 @@ public void setApiClient(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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original 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 gouping 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 @@ -76,7 +76,7 @@ public TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(Templated /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original 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 gouping 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 @@ -399,7 +399,7 @@ public ApiResponse getTemplatedPAComponentsInPa } /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original 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 gouping 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 @@ -424,7 +424,7 @@ public TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(String id /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original 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 gouping 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> 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 491bfe1f..4ee20cca 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 @@ -54,7 +54,7 @@ public void setApiClient(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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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 @@ -77,7 +77,7 @@ public UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(UnlinkedPATem /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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 @@ -561,7 +561,7 @@ public ApiResponse getUnlinkedPATemplatesByIdWithHttpInf } /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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 @@ -586,7 +586,7 @@ public UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(String id, Un /** * 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. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * 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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + * 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 gouping 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> 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 new file mode 100644 index 00000000..893e79fa --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java @@ -0,0 +1,140 @@ + +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-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-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.
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.
404 One or more calculation settings were unavailable. * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
409 Duplicate calculation exists with same parameters. * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
413 Request body too large * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
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.
+ + + + + + + + + +
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/models/CalculationUnitStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java index 51a7dc8c..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 @@ -38,7 +38,8 @@ CalculationUnitStatus.JSON_PROPERTY_ERRORS, CalculationUnitStatus.JSON_PROPERTY_RESULT, CalculationUnitStatus.JSON_PROPERTY_PROGRESS, - CalculationUnitStatus.JSON_PROPERTY_POINTS + CalculationUnitStatus.JSON_PROPERTY_POINTS, + CalculationUnitStatus.JSON_PROPERTY_WARNINGS }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class CalculationUnitStatus implements Serializable { @@ -100,6 +101,9 @@ public static StatusEnum fromValue(String value) { public static final String JSON_PROPERTY_POINTS = "points"; private Integer points; + public static final String JSON_PROPERTY_WARNINGS = "warnings"; + private java.util.List warnings = null; + public CalculationUnitStatus status(StatusEnum status) { this.status = status; @@ -229,6 +233,38 @@ public void setPoints(Integer points) { } + public CalculationUnitStatus warnings(java.util.List warnings) { + this.warnings = warnings; + return this; + } + + public CalculationUnitStatus addWarningsItem(String warningsItem) { + if (this.warnings == null) { + this.warnings = new java.util.ArrayList(); + } + this.warnings.add(warningsItem); + return this; + } + + /** + * The warnings in a calculation unit. + * @return warnings + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The warnings in a calculation unit.") + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getWarnings() { + return warnings; + } + + + public void setWarnings(java.util.List warnings) { + this.warnings = warnings; + } + + /** * Return true if this CalculationUnitStatus object is equal to o. */ @@ -245,12 +281,13 @@ public boolean equals(Object o) { Objects.equals(this.errors, calculationUnitStatus.errors) && Objects.equals(this.result, calculationUnitStatus.result) && Objects.equals(this.progress, calculationUnitStatus.progress) && - Objects.equals(this.points, calculationUnitStatus.points); + Objects.equals(this.points, calculationUnitStatus.points) && + Objects.equals(this.warnings, calculationUnitStatus.warnings); } @Override public int hashCode() { - return Objects.hash(status, errors, result, progress, points); + return Objects.hash(status, errors, result, progress, points, warnings); } @Override @@ -262,6 +299,7 @@ public String toString() { sb.append(" result: ").append(toIndentedString(result)).append("\n"); sb.append(" progress: ").append(toIndentedString(progress)).append("\n"); sb.append(" points: ").append(toIndentedString(points)).append("\n"); + sb.append(" warnings: ").append(toIndentedString(warnings)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java index 6385bf67..f76c609d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java @@ -35,6 +35,8 @@ */ @JsonPropertyOrder({ Error.JSON_PROPERTY_ID, + Error.JSON_PROPERTY_CODE, + Error.JSON_PROPERTY_TITLE, Error.JSON_PROPERTY_DETAIL, Error.JSON_PROPERTY_SOURCE }) @@ -45,6 +47,12 @@ public class Error implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public static final String JSON_PROPERTY_CODE = "code"; + private String code; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + public static final String JSON_PROPERTY_DETAIL = "detail"; private String detail; @@ -76,6 +84,54 @@ public void setId(String id) { } + public Error code(String code) { + this.code = code; + return this; + } + + /** + * Get code + * @return code + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCode() { + return code; + } + + + public void setCode(String code) { + this.code = code; + } + + + public Error title(String title) { + this.title = title; + return this; + } + + /** + * Get title + * @return title + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + public void setTitle(String title) { + this.title = title; + } + + public Error detail(String detail) { this.detail = detail; return this; @@ -137,13 +193,15 @@ public boolean equals(Object o) { } Error error = (Error) o; return Objects.equals(this.id, error.id) && + Objects.equals(this.code, error.code) && + Objects.equals(this.title, error.title) && Objects.equals(this.detail, error.detail) && Objects.equals(this.source, error.source); } @Override public int hashCode() { - return Objects.hash(id, detail, source); + return Objects.hash(id, code, title, detail, source); } @Override @@ -151,6 +209,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Error {\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" code: ").append(toIndentedString(code)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" detail: ").append(toIndentedString(detail)).append("\n"); sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIAttributionForJobSettings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIAttributionForJobSettings.java new file mode 100644 index 00000000..99f585ae --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIAttributionForJobSettings.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; + + +/** + * FIAttributionForJobSettings + */ +@JsonPropertyOrder({ + FIAttributionForJobSettings.JSON_PROPERTY_START_DATE, + FIAttributionForJobSettings.JSON_PROPERTY_END_DATE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIAttributionForJobSettings 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 FIAttributionForJobSettings startDate(String startDate) { + this.startDate = startDate; + return this; + } + + /** + * Start Date + * @return startDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Start Date") + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStartDate() { + return startDate; + } + + + public void setStartDate(String startDate) { + this.startDate = startDate; + } + + + public FIAttributionForJobSettings endDate(String endDate) { + this.endDate = endDate; + return this; + } + + /** + * End Date + * @return endDate + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "End Date") + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEndDate() { + return endDate; + } + + + public void setEndDate(String endDate) { + this.endDate = endDate; + } + + + /** + * Return true if this FIAttributionForJobSettings object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIAttributionForJobSettings fiAttributionForJobSettings = (FIAttributionForJobSettings) o; + return Objects.equals(this.startDate, fiAttributionForJobSettings.startDate) && + Objects.equals(this.endDate, fiAttributionForJobSettings.endDate); + } + + @Override + public int hashCode() { + return Objects.hash(startDate, endDate); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIAttributionForJobSettings {\n"); + sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).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/FIAttributionForSecurities.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIAttributionForSecurities.java new file mode 100644 index 00000000..c58e37eb --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIAttributionForSecurities.java @@ -0,0 +1,270 @@ +/* + * 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; + + +/** + * FIAttributionForSecurities + */ +@JsonPropertyOrder({ + FIAttributionForSecurities.JSON_PROPERTY_START_PRICE, + FIAttributionForSecurities.JSON_PROPERTY_END_PRICE, + FIAttributionForSecurities.JSON_PROPERTY_START_SPREAD, + FIAttributionForSecurities.JSON_PROPERTY_END_SPREAD, + FIAttributionForSecurities.JSON_PROPERTY_PRICING_METHOD +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIAttributionForSecurities implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_START_PRICE = "startPrice"; + private Double startPrice; + + public static final String JSON_PROPERTY_END_PRICE = "endPrice"; + private Double endPrice; + + public static final String JSON_PROPERTY_START_SPREAD = "startSpread"; + private Double startSpread; + + public static final String JSON_PROPERTY_END_SPREAD = "endSpread"; + private Double endSpread; + + /** + * Pricing Method + */ + public enum PricingMethodEnum { + INPUTTED_PRICE("Inputted Price"), + + PRICING_MATRIX("Pricing Matrix"), + + ACTUAL_SPREAD("Actual Spread"), + + OAS("OAS"); + + private String value; + + PricingMethodEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static PricingMethodEnum fromValue(String value) { + for (PricingMethodEnum b : PricingMethodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_PRICING_METHOD = "pricingMethod"; + private PricingMethodEnum pricingMethod; + + + public FIAttributionForSecurities startPrice(Double startPrice) { + this.startPrice = startPrice; + return this; + } + + /** + * Start Price + * @return startPrice + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Start Price") + @JsonProperty(JSON_PROPERTY_START_PRICE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getStartPrice() { + return startPrice; + } + + + public void setStartPrice(Double startPrice) { + this.startPrice = startPrice; + } + + + public FIAttributionForSecurities endPrice(Double endPrice) { + this.endPrice = endPrice; + return this; + } + + /** + * End Price + * @return endPrice + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "End Price") + @JsonProperty(JSON_PROPERTY_END_PRICE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEndPrice() { + return endPrice; + } + + + public void setEndPrice(Double endPrice) { + this.endPrice = endPrice; + } + + + public FIAttributionForSecurities startSpread(Double startSpread) { + this.startSpread = startSpread; + return this; + } + + /** + * Start Spread + * @return startSpread + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Start Spread") + @JsonProperty(JSON_PROPERTY_START_SPREAD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getStartSpread() { + return startSpread; + } + + + public void setStartSpread(Double startSpread) { + this.startSpread = startSpread; + } + + + public FIAttributionForSecurities endSpread(Double endSpread) { + this.endSpread = endSpread; + return this; + } + + /** + * End Spread + * @return endSpread + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "End Spread") + @JsonProperty(JSON_PROPERTY_END_SPREAD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getEndSpread() { + return endSpread; + } + + + public void setEndSpread(Double endSpread) { + this.endSpread = endSpread; + } + + + public FIAttributionForSecurities pricingMethod(PricingMethodEnum pricingMethod) { + this.pricingMethod = pricingMethod; + return this; + } + + /** + * Pricing Method + * @return pricingMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Pricing Method") + @JsonProperty(JSON_PROPERTY_PRICING_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PricingMethodEnum getPricingMethod() { + return pricingMethod; + } + + + public void setPricingMethod(PricingMethodEnum pricingMethod) { + this.pricingMethod = pricingMethod; + } + + + /** + * Return true if this FIAttributionForSecurities object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIAttributionForSecurities fiAttributionForSecurities = (FIAttributionForSecurities) o; + return Objects.equals(this.startPrice, fiAttributionForSecurities.startPrice) && + Objects.equals(this.endPrice, fiAttributionForSecurities.endPrice) && + Objects.equals(this.startSpread, fiAttributionForSecurities.startSpread) && + Objects.equals(this.endSpread, fiAttributionForSecurities.endSpread) && + Objects.equals(this.pricingMethod, fiAttributionForSecurities.pricingMethod); + } + + @Override + public int hashCode() { + return Objects.hash(startPrice, endPrice, startSpread, endSpread, pricingMethod); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIAttributionForSecurities {\n"); + sb.append(" startPrice: ").append(toIndentedString(startPrice)).append("\n"); + sb.append(" endPrice: ").append(toIndentedString(endPrice)).append("\n"); + sb.append(" startSpread: ").append(toIndentedString(startSpread)).append("\n"); + sb.append(" endSpread: ").append(toIndentedString(endSpread)).append("\n"); + sb.append(" pricingMethod: ").append(toIndentedString(pricingMethod)).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/FIJobSettings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java index 186cc6e3..12f753e9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java @@ -22,6 +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.FIAttributionForJobSettings; import factset.analyticsapi.engines.models.FIBankLoans; import factset.analyticsapi.engines.models.FIMarketEnvironment; import factset.analyticsapi.engines.models.FIMunicipalBondsForJobSettings; @@ -45,7 +46,8 @@ FIJobSettings.JSON_PROPERTY_BANK_LOANS, FIJobSettings.JSON_PROPERTY_MUNICIPAL_BONDS, FIJobSettings.JSON_PROPERTY_MARKET_ENVIRONMENT, - FIJobSettings.JSON_PROPERTY_STRUCTURED_PRODUCTS + FIJobSettings.JSON_PROPERTY_STRUCTURED_PRODUCTS, + FIJobSettings.JSON_PROPERTY_ATTRIBUTION }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class FIJobSettings implements Serializable { @@ -117,6 +119,9 @@ public static CallMethodEnum fromValue(String value) { public static final String JSON_PROPERTY_STRUCTURED_PRODUCTS = "structuredProducts"; private FIStructuredProductsForJobSettings structuredProducts; + public static final String JSON_PROPERTY_ATTRIBUTION = "attribution"; + private FIAttributionForJobSettings attribution; + public FIJobSettings asOfDate(String asOfDate) { this.asOfDate = asOfDate; @@ -341,6 +346,30 @@ public void setStructuredProducts(FIStructuredProductsForJobSettings structuredP } + public FIJobSettings attribution(FIAttributionForJobSettings attribution) { + this.attribution = attribution; + return this; + } + + /** + * Get attribution + * @return attribution + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ATTRIBUTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIAttributionForJobSettings getAttribution() { + return attribution; + } + + + public void setAttribution(FIAttributionForJobSettings attribution) { + this.attribution = attribution; + } + + /** * Return true if this FIJobSettings object is equal to o. */ @@ -361,12 +390,13 @@ public boolean equals(Object o) { Objects.equals(this.bankLoans, fiJobSettings.bankLoans) && Objects.equals(this.municipalBonds, fiJobSettings.municipalBonds) && Objects.equals(this.marketEnvironment, fiJobSettings.marketEnvironment) && - Objects.equals(this.structuredProducts, fiJobSettings.structuredProducts); + Objects.equals(this.structuredProducts, fiJobSettings.structuredProducts) && + Objects.equals(this.attribution, fiJobSettings.attribution); } @Override public int hashCode() { - return Objects.hash(asOfDate, partialDurationMonths, callMethod, settlement, calcFromMethod, bankLoans, municipalBonds, marketEnvironment, structuredProducts); + return Objects.hash(asOfDate, partialDurationMonths, callMethod, settlement, calcFromMethod, bankLoans, municipalBonds, marketEnvironment, structuredProducts, attribution); } @Override @@ -382,6 +412,7 @@ public String toString() { sb.append(" municipalBonds: ").append(toIndentedString(municipalBonds)).append("\n"); sb.append(" marketEnvironment: ").append(toIndentedString(marketEnvironment)).append("\n"); sb.append(" structuredProducts: ").append(toIndentedString(structuredProducts)).append("\n"); + sb.append(" attribution: ").append(toIndentedString(attribution)).append("\n"); sb.append("}"); return sb.toString(); } 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 a0a667fe..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 @@ -22,6 +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.FIAttributionForSecurities; import factset.analyticsapi.engines.models.FIBankLoans; import factset.analyticsapi.engines.models.FILoss; import factset.analyticsapi.engines.models.FIMunicipalBonds; @@ -49,6 +50,7 @@ FISecurity.JSON_PROPERTY_MATRIX_SPREAD_ADJUSTMENT, FISecurity.JSON_PROPERTY_MATRIX_MULTIPLIER, FISecurity.JSON_PROPERTY_STRUCTURED_PRODUCTS, + FISecurity.JSON_PROPERTY_ATTRIBUTION, FISecurity.JSON_PROPERTY_CALC_FROM_METHOD, FISecurity.JSON_PROPERTY_CALC_FROM_VALUE, FISecurity.JSON_PROPERTY_FACE, @@ -129,6 +131,9 @@ public static CallMethodEnum fromValue(String value) { public static final String JSON_PROPERTY_STRUCTURED_PRODUCTS = "structuredProducts"; private FIStructuredProductsForSecurities structuredProducts; + public static final String JSON_PROPERTY_ATTRIBUTION = "attribution"; + private FIAttributionForSecurities attribution; + public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; private String calcFromMethod; @@ -423,6 +428,30 @@ public void setStructuredProducts(FIStructuredProductsForSecurities structuredPr } + public FISecurity attribution(FIAttributionForSecurities attribution) { + this.attribution = attribution; + return this; + } + + /** + * Get attribution + * @return attribution + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ATTRIBUTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIAttributionForSecurities getAttribution() { + return attribution; + } + + + public void setAttribution(FIAttributionForSecurities attribution) { + this.attribution = attribution; + } + + public FISecurity calcFromMethod(String calcFromMethod) { this.calcFromMethod = calcFromMethod; return this; @@ -587,6 +616,7 @@ public boolean equals(Object o) { Objects.equals(this.matrixSpreadAdjustment, fiSecurity.matrixSpreadAdjustment) && Objects.equals(this.matrixMultiplier, fiSecurity.matrixMultiplier) && Objects.equals(this.structuredProducts, fiSecurity.structuredProducts) && + Objects.equals(this.attribution, fiSecurity.attribution) && Objects.equals(this.calcFromMethod, fiSecurity.calcFromMethod) && Objects.equals(this.calcFromValue, fiSecurity.calcFromValue) && Objects.equals(this.face, fiSecurity.face) && @@ -597,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, 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 @@ -614,6 +644,7 @@ public String toString() { sb.append(" matrixSpreadAdjustment: ").append(toIndentedString(matrixSpreadAdjustment)).append("\n"); 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(" 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/PAComponentData.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java index 1a54f55a..4ef3d796 100644 --- 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 @@ -282,11 +282,11 @@ public PAComponentData componentdetail(String componentdetail) { } /** - * PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + * 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 TOTALS or SECURITIES.") + @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) diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARComponent.java new file mode 100644 index 00000000..b017dcc5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARComponent.java @@ -0,0 +1,300 @@ +/* + * 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.SPARIdentifier; +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; + + +/** + * SPARComponent + */ +@JsonPropertyOrder({ + SPARComponent.JSON_PROPERTY_ID, + SPARComponent.JSON_PROPERTY_ACCOUNTS, + SPARComponent.JSON_PROPERTY_BENCHMARKS, + SPARComponent.JSON_PROPERTY_CURRENCY_ISO_CODE, + SPARComponent.JSON_PROPERTY_PATH, + SPARComponent.JSON_PROPERTY_NAME, + SPARComponent.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class SPARComponent 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 SPARIdentifier benchmarks; + + public static final String JSON_PROPERTY_CURRENCY_ISO_CODE = "currencyIsoCode"; + private String currencyIsoCode; + + 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 SPARComponent 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 SPARComponent accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public SPARComponent addAccountsItem(SPARIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts in SPAR document. + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts in SPAR 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 SPARComponent benchmarks(SPARIdentifier benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + /** + * Get benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SPARIdentifier getBenchmarks() { + return benchmarks; + } + + + public void setBenchmarks(SPARIdentifier benchmarks) { + this.benchmarks = benchmarks; + } + + + public SPARComponent currencyIsoCode(String currencyIsoCode) { + this.currencyIsoCode = currencyIsoCode; + return this; + } + + /** + * CurrencyCode in SPAR document. + * @return currencyIsoCode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "CurrencyCode in SPAR document.") + @JsonProperty(JSON_PROPERTY_CURRENCY_ISO_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyIsoCode() { + return currencyIsoCode; + } + + + public void setCurrencyIsoCode(String currencyIsoCode) { + this.currencyIsoCode = currencyIsoCode; + } + + + public SPARComponent 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 SPARComponent 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 SPARComponent 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 SPARComponent object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SPARComponent spARComponent = (SPARComponent) o; + return Objects.equals(this.id, spARComponent.id) && + Objects.equals(this.accounts, spARComponent.accounts) && + Objects.equals(this.benchmarks, spARComponent.benchmarks) && + Objects.equals(this.currencyIsoCode, spARComponent.currencyIsoCode) && + Objects.equals(this.path, spARComponent.path) && + Objects.equals(this.name, spARComponent.name) && + Objects.equals(this.category, spARComponent.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, accounts, benchmarks, currencyIsoCode, path, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SPARComponent {\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(" 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/SPARComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARComponentRoot.java new file mode 100644 index 00000000..17c17595 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARComponentRoot.java @@ -0,0 +1,112 @@ +/* + * 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.SPARComponent; +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; + + +/** + * SPARComponentRoot + */ +@JsonPropertyOrder({ + SPARComponentRoot.JSON_PROPERTY_DATA +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class SPARComponentRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private SPARComponent data; + + + public SPARComponentRoot data(SPARComponent 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 SPARComponent getData() { + return data; + } + + + public void setData(SPARComponent data) { + this.data = data; + } + + + /** + * Return true if this SPARComponentRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SPARComponentRoot spARComponentRoot = (SPARComponentRoot) o; + return Objects.equals(this.data, spARComponentRoot.data); + } + + @Override + public int hashCode() { + return Objects.hash(data); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SPARComponentRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).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 index 67691117..5c840c05 100644 --- 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 @@ -411,11 +411,11 @@ public UnlinkedPATemplate componentdetail(String componentdetail) { } /** - * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * 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 TOTALS or SECURITIES.") + @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) 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 index a194ae2f..94277a1e 100644 --- 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 @@ -369,11 +369,11 @@ public UnlinkedPATemplateParameters componentdetail(String componentdetail) { } /** - * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * 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 TOTALS or SECURITIES.") + @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) 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 index 4930b85a..98365ef4 100644 --- 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 @@ -315,11 +315,11 @@ public UnlinkedPATemplateUpdateParameters componentdetail(String componentdetail } /** - * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * 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 TOTALS or SECURITIES.") + @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) 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/VaultAttributionLoaderResponseRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java new file mode 100644 index 00000000..d5c0bff0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.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.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 "); + } + +} +