diff --git a/languages/dotnet/openapi-generator-config.json b/languages/dotnet/openapi-generator-config.json index c666a12..b78bd7b 100644 --- a/languages/dotnet/openapi-generator-config.json +++ b/languages/dotnet/openapi-generator-config.json @@ -1,6 +1,6 @@ { "packageName": "FactSet.AnalyticsAPI.Engines", - "packageVersion": "5.4.0", + "packageVersion": "5.7.0", "packageGuid": "{D7309227-518B-45ED-896A-4853BE6A9075}", "targetFramework": "netstandard2.0", "caseInsensitiveResponseHeaders": true, @@ -16,5 +16,5 @@ "licenseId": "Apache-2.0", "releaseNote": "Refer to Changelog on GitHub source repository", "packageTags": "PA;Vault;SPAR;Engines;FactSet;FDS;API;Analytics;AnalyticsAPI", - "httpUserAgent": "engines-api/5.4.0/csharp" + "httpUserAgent": "engines-api/5.7.0/csharp" } diff --git a/languages/java/openapi-generator-config.json b/languages/java/openapi-generator-config.json index 347a32b..a383937 100644 --- a/languages/java/openapi-generator-config.json +++ b/languages/java/openapi-generator-config.json @@ -4,7 +4,7 @@ "invokerPackage": "factset.analyticsapi.engines", "groupId": "com.factset.analyticsapi", "artifactId": "engines-sdk", - "artifactVersion": "5.5.0", + "artifactVersion": "5.6.0-rc.1", "artifactUrl": "https://github.com/factset/analyticsapi-engines-java-sdk", "artifactDescription": "SDK for FactSet Analytics Engines API", "scmConnection": "scm:git:git://github.com/factset/analyticsapi-engines-java-sdk.git", @@ -24,5 +24,5 @@ "caseInsensitiveResponseHeaders": true, "library": "jersey2", "servers": false, - "httpUserAgent": "engines-api/5.5.0/java" + "httpUserAgent": "engines-api/5.6.0-rc.1/java" } diff --git a/languages/python/openapi-generator-config.json b/languages/python/openapi-generator-config.json index 6a1d8c2..70f1c6d 100644 --- a/languages/python/openapi-generator-config.json +++ b/languages/python/openapi-generator-config.json @@ -1,7 +1,7 @@ { "packageName": "fds.analyticsapi.engines", "projectName": "fds.analyticsapi.engines", - "packageVersion": "5.6.0", + "packageVersion": "5.7.0-rc.1", "packageUrl": "https://github.com/factset/analyticsapi-engines-python-sdk", - "httpUserAgent": "engines-api/5.6.0/python" + "httpUserAgent": "engines-api/5.7.0-rc.1/python" } diff --git a/openapi-schema-oneof-referenced-schema.json b/openapi-schema-oneof-referenced-schema.json index c1eccd7..9a23631 100644 --- a/openapi-schema-oneof-referenced-schema.json +++ b/openapi-schema-oneof-referenced-schema.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Engines API", - "description": "Allow clients to fetch Analytics through APIs.", + "description": "Allow clients to fetch Analytics through API.", "contact": { "name": "FactSet Research Systems", "url": "https://developer.factset.com/contact", @@ -351,12 +351,12 @@ { "name": "path", "in": "path", - "description": "The directory to get the accounts and sub-directories in", + "description": "The directory to get the accounts and sub-directories.", "required": true, "schema": { "type": "string", - "description": "The directory to get the accounts and sub-directories in", - "default": "" + "description": "The directory to get the accounts and sub-directories.", + "example": "Client:" } } ], @@ -671,9 +671,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -1089,9 +1090,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -2675,9 +2677,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -3093,9 +3096,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -4683,7 +4687,8 @@ "required": true, "schema": { "type": "string", - "description": "Benchmark Identifier" + "description": "Benchmark Identifier", + "example": "R.1000" } } ], @@ -4998,9 +5003,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -5416,9 +5422,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -7006,7 +7013,8 @@ "schema": { "type": "string", "description": "Column name", - "default": "" + "default": "", + "example": "Security Name" } }, { @@ -7026,7 +7034,8 @@ "schema": { "type": "string", "description": "The directory to get the columns in", - "default": "" + "default": "", + "example": "Client" } } ], @@ -7264,7 +7273,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a column" + "description": "Unique identifier for a column", + "example": "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7" } } ], @@ -7809,7 +7819,8 @@ "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Document Name", + "example": "PA3_DOCUMENTS:DEFAULT" } } ], @@ -8128,7 +8139,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a PA component" + "description": "Unique identifier for a PA component", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" } } ], @@ -8447,7 +8459,8 @@ "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Document Name", + "example": "SPAR_DOCUMENTS:Factset Default Document" } } ], @@ -8750,29 +8763,30 @@ ] } }, - "/analytics/engines/vault/v3/components": { + "/analytics/engines/spar/v3/components/{id}": { "get": { "tags": [ "Components" ], - "summary": "Get Vault components", - "description": "This endpoint returns the list of Vault components in a given Vault document.", - "operationId": "getVaultComponents", + "summary": "Get SPAR component by id", + "description": "This endpoint returns the default settings of a SPAR component.", + "operationId": "getSPARComponentById", "parameters": [ { - "name": "document", - "in": "query", - "description": "Document Name", + "name": "id", + "in": "path", + "description": "Unique identifier for a SPAR component", "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Unique identifier for a SPAR component", + "example": "067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D" } } ], "responses": { "200": { - "description": "Expected response, returns a list of Vault components.", + "description": "Expected response, returns the default settings of a SPAR component.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -8810,13 +8824,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ComponentSummaryRoot" + "$ref": "#/components/schemas/SPARComponentRoot" } } } }, "400": { - "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.", @@ -8860,7 +8874,7 @@ } }, "404": { - "description": "Vault Document not found.", + "description": "Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9064,34 +9078,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "ComponentSummaryRoot" + "response-type": "SPARComponentRoot" } ] } }, - "/analytics/engines/vault/v3/components/{id}": { + "/analytics/engines/vault/v3/components": { "get": { "tags": [ "Components" ], - "summary": "Get Vault component by id", - "description": "This endpoint returns the default settings of a Vault component.", - "operationId": "getVaultComponentById", + "summary": "Get Vault components", + "description": "This endpoint returns the list of Vault components in a given Vault document.", + "operationId": "getVaultComponents", "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for a vault component", + "name": "document", + "in": "query", + "description": "Document Name", "required": true, "schema": { "type": "string", - "description": "Unique identifier for a vault component" + "description": "Document Name" } } ], "responses": { "200": { - "description": "Expected response, returns the default settings of a Vault component.", + "description": "Expected response, returns a list of Vault components.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9129,13 +9143,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultComponentRoot" + "$ref": "#/components/schemas/ComponentSummaryRoot" } } } }, "400": { - "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.", @@ -9179,7 +9193,7 @@ } }, "404": { - "description": "Vault Component not found.", + "description": "Vault Document not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9383,34 +9397,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultComponentRoot" + "response-type": "ComponentSummaryRoot" } ] } }, - "/analytics/engines/vault/v3/configurations": { + "/analytics/engines/vault/v3/components/{id}": { "get": { "tags": [ - "Configurations" + "Components" ], - "summary": "Get Vault configurations", - "description": "This endpoint returns all the Vault configurations saved in the provided account.", - "operationId": "getVaultConfigurations", + "summary": "Get Vault component by id", + "description": "This endpoint returns the default settings of a Vault component.", + "operationId": "getVaultComponentById", "parameters": [ { - "name": "account", - "in": "query", - "description": "Required account query parameter to filter configurations for a specific account", + "name": "id", + "in": "path", + "description": "Unique identifier for a vault component", "required": true, "schema": { "type": "string", - "description": "Required account query parameter to filter configurations for a specific account" + "description": "Unique identifier for a vault component" } } ], "responses": { "200": { - "description": "Expected response, returns a dictionary of Vault configurations.", + "description": "Expected response, returns the default settings of a Vault component.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9448,13 +9462,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" + "$ref": "#/components/schemas/VaultComponentRoot" } } } }, "400": { - "description": "Invalid account.", + "description": "Invalid Vault component id.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9498,7 +9512,7 @@ } }, "404": { - "description": "Account not found.", + "description": "Vault Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9702,34 +9716,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultConfigurationSummaryRoot" + "response-type": "VaultComponentRoot" } ] } }, - "/analytics/engines/vault/v3/configurations/{id}": { + "/analytics/engines/vault/v3/configurations": { "get": { "tags": [ "Configurations" ], - "summary": "Get Vault configuration by id", - "description": "This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.", - "operationId": "getVaultConfigurationById", + "summary": "Get Vault configurations", + "description": "This endpoint returns all the Vault configurations saved in the provided account.", + "operationId": "getVaultConfigurations", "parameters": [ { - "name": "id", - "in": "path", - "description": "Vault configuration id to get the details of", + "name": "account", + "in": "query", + "description": "Required account query parameter to filter configurations for a specific account", "required": true, "schema": { "type": "string", - "description": "Vault configuration id to get the details of" + "description": "Required account query parameter to filter configurations for a specific account" } } ], "responses": { "200": { - "description": "Expected response, returns details for a Vault configuration.", + "description": "Expected response, returns a dictionary of Vault configurations.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9767,13 +9781,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultConfigurationRoot" + "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" } } } }, "400": { - "description": "Invalid vault configuration code.", + "description": "Invalid account.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9817,7 +9831,7 @@ } }, "404": { - "description": "Vault configuration id not found.", + "description": "Account not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -10021,22 +10035,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultConfigurationRoot" + "response-type": "VaultConfigurationSummaryRoot" } ] } }, - "/analytics/lookups/v3/currencies": { + "/analytics/engines/vault/v3/configurations/{id}": { "get": { "tags": [ - "Currencies" + "Configurations" + ], + "summary": "Get Vault configuration by id", + "description": "This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.", + "operationId": "getVaultConfigurationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Vault configuration id to get the details of", + "required": true, + "schema": { + "type": "string", + "description": "Vault configuration id to get the details of" + } + } ], - "summary": "Get currencies", - "description": "This endpoint lists all the currencies that can be applied to any calculation.", - "operationId": "getCurrencies", "responses": { "200": { - "description": "Expected response, returns a list of currencies.", + "description": "Expected response, returns details for a Vault configuration.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -10074,7 +10100,95 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyRoot" + "$ref": "#/components/schemas/VaultConfigurationRoot" + } + } + } + }, + "400": { + "description": "Invalid vault configuration code.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Vault configuration id not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" } } } @@ -10240,63 +10354,286 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "CurrencyRoot" + "response-type": "VaultConfigurationRoot" } ] } }, - "/analytics/engines/pa/v3/dates": { + "/analytics/lookups/v3/currencies": { "get": { "tags": [ - "Dates" - ], - "summary": "Convert PA dates to absolute format", - "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": [ - { - "name": "startdate", - "in": "query", - "description": "Start Date", - "schema": { - "type": "string", - "description": "Start Date" - } - }, - { - "name": "enddate", - "in": "query", - "description": "End Date", - "required": true, - "schema": { - "type": "string", - "description": "End Date" - } - }, - { - "name": "componentid", - "in": "query", - "description": "Component Id", - "required": true, - "schema": { - "type": "string", - "description": "Component Id" - } - }, - { - "name": "account", - "in": "query", - "description": "Account", - "required": true, - "schema": { - "type": "string", - "description": "Account" - } - } + "Currencies" ], + "summary": "Get currencies", + "description": "This endpoint lists all the currencies that can be applied to any calculation.", + "operationId": "getCurrencies", "responses": { "200": { - "description": "Expected response, returns the converted dates in yyyymmdd format.", + "description": "Expected response, returns a list of currencies.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyRoot" + } + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "403": { + "description": "User is forbidden with current credentials", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CurrencyRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/dates": { + "get": { + "tags": [ + "Dates" + ], + "summary": "Convert PA dates to absolute format", + "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": [ + { + "name": "startdate", + "in": "query", + "description": "Start Date", + "schema": { + "type": "string", + "description": "Start Date", + "example": "-3AY" + } + }, + { + "name": "enddate", + "in": "query", + "description": "End Date", + "required": true, + "schema": { + "type": "string", + "description": "End Date", + "example": "-1AY" + } + }, + { + "name": "componentid", + "in": "query", + "description": "Component Id", + "required": true, + "schema": { + "type": "string", + "description": "Component Id", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" + } + }, + { + "name": "account", + "in": "query", + "description": "Account ( Account Name ending with .ACCT or .ACTM )", + "required": true, + "schema": { + "type": "string", + "description": "Account ( Account Name ending with .ACCT or .ACTM )", + "example": "Client:/Folder1/Folder2/AccountName.ACCT" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the converted dates in yyyymmdd format.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11230,7 +11567,7 @@ "schema": { "type": "string", "description": "The directory to get the documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -11550,7 +11887,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -11870,7 +12207,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -12190,7 +12527,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -13489,9 +13826,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -14067,9 +14405,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -15708,9 +16047,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -16126,9 +16466,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -19134,7 +19475,8 @@ "description": "Get linked PA templates in path.", "schema": { "type": "string", - "description": "Get linked PA templates in path." + "description": "Get linked PA templates in path.", + "example": "Personal:LinkedPATemplates/" } }, { @@ -19471,7 +19813,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -19799,7 +20142,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -20129,7 +20473,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -20444,9 +20789,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -20862,9 +21208,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -22442,15 +22789,16 @@ "PACalculations" ], "summary": "Create and Run PA calculation", - "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.", + "description": "This endpoint runs the PA calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. \r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "postAndCalculate", "parameters": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -22927,7 +23275,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -23240,7 +23587,7 @@ "PACalculations" ], "summary": "Create or Update PA calculation and run it.", - "description": "This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "description": "This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "putAndCalculate", "parameters": [ { @@ -23256,9 +23603,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -25319,9 +25667,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -25801,7 +26150,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -26130,9 +26478,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -28275,6 +28624,55 @@ } } }, + "413": { + "description": "Request body too large", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -28477,7 +28875,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -29124,27 +29521,8 @@ } } }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", + "413": { + "description": "Request body too large", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29178,109 +29556,22 @@ "type": "string" } } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "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.", + }, + "content": { + "application/json": { "schema": { - "type": "string", - "description": "FactSet's request key header." + "$ref": "#/components/schemas/ClientErrorResponse" } }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "application/x-protobuf": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", + "401": { + "description": "Missing or invalid authentication.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29297,68 +29588,10 @@ } } } - } - }, - "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" - } - ] - }, - "get": { - "tags": [ - "QuantCalculations" - ], - "summary": "Get Quant Engine calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the Quant Engine calculation parameters.", + "403": { + "description": "User is forbidden with current credentials", "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -29391,17 +29624,230 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuantCalculationParametersRoot" - } - } } }, - "400": { - "description": "Invalid identifier provided.", + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + } + }, + "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" + } + ] + }, + "get": { + "tags": [ + "QuantCalculations" + ], + "summary": "Get Quant Engine calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the Quant Engine calculation parameters.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuantCalculationParametersRoot" + } + } + } + }, + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30856,9 +31302,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -31335,7 +31782,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -31664,9 +32110,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -33386,7 +33833,7 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -33706,7 +34153,7 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -34026,7 +34473,7 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -34346,7 +34793,7 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -34666,7 +35113,7 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -34975,7 +35422,7 @@ "TemplatedPAComponents" ], "summary": "Create templated PA component", - "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.", + "description": "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "createTemplatedPAComponents", "requestBody": { "description": "Request Parameters", @@ -35314,7 +35761,8 @@ "required": true, "schema": { "type": "string", - "description": "Get templated PA components in path" + "description": "Get templated PA components in path", + "example": "Personal:TemplatedPAComponents/" } } ], @@ -35579,7 +36027,7 @@ "TemplatedPAComponents" ], "summary": "Update templated PA component", - "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.", + "description": "This endpoint allows the user to change the request body from an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "updateTemplatedPAComponents", "parameters": [ { @@ -35589,7 +36037,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], @@ -35917,7 +36366,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], @@ -36234,7 +36684,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], @@ -36556,7 +37007,7 @@ "UnlinkedPATemplates" ], "summary": "Create unlinked PA template", - "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.", + "description": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also \r\n overriding the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "createUnlinkedPATemplates", "requestBody": { "description": "Request Parameters", @@ -36837,7 +37288,8 @@ "description": "Get unlinked PA templates in path.", "schema": { "type": "string", - "description": "Get unlinked PA templates in path." + "description": "Get unlinked PA templates in path.", + "example": "Personal:UninkedPATemplates/" } }, { @@ -36846,7 +37298,8 @@ "description": "Get unlinked PA templates by category.", "schema": { "type": "string", - "description": "Get unlinked PA templates by category." + "description": "Get unlinked PA templates by category.", + "example": "Weights" } } ], @@ -37111,7 +37564,7 @@ "UnlinkedPATemplates" ], "summary": "Update unlinked PA template", - "description": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* 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.", + "description": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "updateUnlinkedPATemplates", "parameters": [ { @@ -37121,7 +37574,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -37449,7 +37903,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -37759,7 +38214,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -38600,53 +39056,348 @@ ] } }, - "/analytics/engines/vault/v3/calculations": { + "/analytics/engines/vault/v3/load/{batchId}": { "post": { "tags": [ - "VaultCalculations" + "Vault Attribution Loader" ], - "summary": "Create and Run Vault calculation", - "description": "This endpoint runs the Vault calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", - "operationId": "postAndCalculate", + "summary": "Vault - External Attribution Loader", + "description": "This endpoint loads Vault External Attributions.", + "operationId": "vaultAttributionLoader", "parameters": [ { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", - "schema": { - "type": "integer" - } - }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts max-stale.", + "name": "batchId", + "in": "path", + "required": true, "schema": { "type": "string" } } ], "requestBody": { - "description": "Calculation Parameters", "content": { - "application/json": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/VaultCalculationParametersRoot" + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "nullable": true + } + } + }, + "encoding": { + "file": { + "style": "form" + } } } } }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "Expected response, returns a status of operation along with errors and warnings if found any.", "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultAttributionLoaderResponseRoot" + } + } + } + }, + "400": { + "description": "Bad Request", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "403": { + "description": "User is forbidden with current credentials", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultAttributionLoaderResponseRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/calculations": { + "post": { + "tags": [ + "VaultCalculations" + ], + "summary": "Create and Run Vault calculation", + "description": "This endpoint runs the Vault calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", + "operationId": "postAndCalculate", + "parameters": [ + { + "name": "X-FactSet-Api-Long-Running-Deadline", + "in": "header", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", + "schema": { + "type": "integer", + "example": "10" + } + }, + { + "name": "Cache-Control", + "in": "header", + "description": "Standard HTTP header. Accepts max-stale.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Calculation Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultCalculationParametersRoot" + } + } + } + }, + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting calculation", + "schema": { + "type": "string", + "description": "URL to poll for the resulting calculation" + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -39091,7 +39842,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -39420,9 +40170,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -41137,8 +41888,7 @@ "id": { "type": "string" } - }, - "additionalProperties": false + } }, "SPARAccounts": { "type": "object", @@ -41150,8 +41900,7 @@ }, "description": "List of SPAR returnsType" } - }, - "additionalProperties": false + } }, "SPARAccountsRoot": { "required": [ @@ -41165,8 +41914,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ErrorSource": { "type": "object", @@ -41177,8 +41925,7 @@ "parameter": { "type": "string" } - }, - "additionalProperties": false + } }, "Error": { "type": "object", @@ -41186,14 +41933,19 @@ "id": { "type": "string" }, + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, "detail": { "type": "string" }, "source": { "$ref": "#/components/schemas/ErrorSource" } - }, - "additionalProperties": false + } }, "ClientErrorResponse": { "type": "object", @@ -41204,8 +41956,7 @@ "$ref": "#/components/schemas/Error" } } - }, - "additionalProperties": false + } }, "AccountDirectories": { "type": "object", @@ -41224,8 +41975,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "AccountDirectoriesRoot": { "required": [ @@ -41239,8 +41989,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategyOverrides": { "type": "object", @@ -41272,8 +42021,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategy": { "required": [ @@ -41288,8 +42036,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "OptimizerAccountOverrides": { "type": "object", @@ -41310,8 +42057,7 @@ "type": "string", "description": "Currency" } - }, - "additionalProperties": false + } }, "OptimizerAccount": { "type": "object", @@ -41323,8 +42069,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "Optimization": { "type": "object", @@ -41341,8 +42086,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "OptimizerTradesList": { "type": "object", @@ -41367,8 +42111,7 @@ "type": "boolean", "description": "Include cash" } - }, - "additionalProperties": false + } }, "OptimizerOptimalHoldings": { "type": "object", @@ -41397,8 +42140,7 @@ "type": "boolean", "description": "Exclude zero" } - }, - "additionalProperties": false + } }, "OptimalPortfolio": { "type": "object", @@ -41433,12 +42175,10 @@ "type": "string", "description": "Action if ofdb date exists" } - }, - "additionalProperties": false + } }, "OptimizerStats": { - "type": "object", - "additionalProperties": false + "type": "object" }, "OptimizerOutputTypes": { "type": "object", @@ -41455,8 +42195,7 @@ "stats": { "$ref": "#/components/schemas/OptimizerStats" } - }, - "additionalProperties": false + } }, "AFIOptimizationParameters": { "required": [ @@ -41477,12 +42216,10 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "OptimizerCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "AFIOptimizationParametersRoot": { "type": "object", @@ -41493,8 +42230,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationInfo": { "type": "object", @@ -41503,8 +42239,7 @@ "type": "string", "description": "Calculation identifier" } - }, - "additionalProperties": false + } }, "CalculationInfoRoot": { "required": [ @@ -41518,8 +42253,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ObjectRoot": { "required": [ @@ -41533,8 +42267,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategyOverrides": { "type": "object", @@ -41566,8 +42299,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategy": { "required": [ @@ -41582,8 +42314,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParameters": { "required": [ @@ -41604,8 +42335,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParametersRoot": { "type": "object", @@ -41616,8 +42346,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARIdentifier": { "required": [ @@ -41631,14 +42360,13 @@ }, "returntype": { "type": "string", - "description": "Benchmark return type." + "description": "Account or benchmark return type." }, "prefix": { "type": "string", - "description": "Benchmark prefix." + "description": "Account or benchmark prefix." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for SPAR calculation." }, "SPARBenchmark": { @@ -41659,8 +42387,7 @@ }, "description": "List of SPAR identifiers" } - }, - "additionalProperties": false + } }, "SPARBenchmarkRoot": { "required": [ @@ -41674,8 +42401,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ConstraintAction": { "type": "object", @@ -41690,8 +42416,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyAlphaOverride": { "type": "object", @@ -41712,8 +42437,7 @@ "returnMultiplier": { "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyOverrides": { "type": "object", @@ -41736,8 +42460,7 @@ "type": "string", "description": "Transaction cost\r\nCan be set to \"\" for local" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategy": { "required": [ @@ -41752,8 +42475,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "BPMOptimization": { "type": "object", @@ -41778,8 +42500,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "BPMOptimizationParameters": { "required": [ @@ -41800,8 +42521,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "BPMOptimizationParametersRoot": { "type": "object", @@ -41812,8 +42532,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "ColumnSummary": { "type": "object", @@ -41831,7 +42550,6 @@ "description": "Column Category" } }, - "additionalProperties": false, "description": "Column settings (name, directory, category)" }, "ColumnSummaryRoot": { @@ -41849,8 +42567,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Column": { "type": "object", @@ -41874,8 +42591,7 @@ "type": "string", "description": "Column Category" } - }, - "additionalProperties": false + } }, "ColumnRoot": { "required": [ @@ -41889,8 +42605,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ColumnStatistic": { "type": "object", @@ -41899,8 +42614,7 @@ "type": "string", "description": "Column Statistic Name" } - }, - "additionalProperties": false + } }, "ColumnStatisticRoot": { "required": [ @@ -41917,8 +42631,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ComponentSummary": { "type": "object", @@ -41931,8 +42644,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "ComponentSummaryRoot": { "required": [ @@ -41949,8 +42661,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "PAIdentifier": { "required": [ @@ -41964,10 +42675,9 @@ }, "holdingsmode": { "type": "string", - "description": "Holdings Mode can be B&H, TBR, OMS or EXT." + "description": "Holdings Mode can be B&H, TBR, OMS , EXT or VLT." } - }, - "additionalProperties": false + } }, "PADateParameters": { "required": [ @@ -41989,7 +42699,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for PA calculation." }, "PAComponent": { @@ -42035,8 +42744,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "PAComponentRoot": { "required": [ @@ -42050,8 +42758,50 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } + }, + "SPARComponent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Component identifier." + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SPARIdentifier" + }, + "description": "List of accounts in SPAR document." + }, + "benchmarks": { + "$ref": "#/components/schemas/SPARIdentifier" + }, + "currencyIsoCode": { + "type": "string", + "description": "CurrencyCode in SPAR document." + }, + "path": { + "type": "string", + "description": "The path to the document" + }, + "name": { + "type": "string", + "description": "Component name." + }, + "category": { + "type": "string", + "description": "Component category." + } + } + }, + "SPARComponentRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SPARComponent" + } + } }, "VaultIdentifier": { "required": [ @@ -42064,7 +42814,6 @@ "description": "User's FactSet account path OR benchmark." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for Vault calculation." }, "VaultDateParameters": { @@ -42087,7 +42836,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for Vault calculation" }, "VaultComponent": { @@ -42126,8 +42874,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "VaultComponentRoot": { "required": [ @@ -42141,8 +42888,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "VaultConfigurationSummary": { "type": "object", @@ -42151,8 +42897,7 @@ "type": "string", "description": "Configuration name." } - }, - "additionalProperties": false + } }, "VaultConfigurationSummaryRoot": { "required": [ @@ -42169,8 +42914,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ConfigurationAccount": { "type": "object", @@ -42199,8 +42943,7 @@ "type": "string", "description": "Account name." } - }, - "additionalProperties": false + } }, "VaultConfiguration": { "type": "object", @@ -42215,8 +42958,7 @@ "$ref": "#/components/schemas/ConfigurationAccount" } } - }, - "additionalProperties": false + } }, "VaultConfigurationRoot": { "required": [ @@ -42230,8 +42972,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Currency": { "type": "object", @@ -42240,8 +42981,7 @@ "type": "string", "description": "Name of currency." } - }, - "additionalProperties": false + } }, "CurrencyRoot": { "required": [ @@ -42258,8 +42998,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "DateParametersSummary": { "type": "object", @@ -42272,8 +43011,7 @@ "type": "string", "description": "End date in YYYYMMDD format." } - }, - "additionalProperties": false + } }, "DateParametersSummaryRoot": { "required": [ @@ -42287,8 +43025,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfo": { "type": "object", @@ -42302,8 +43039,7 @@ "currency": { "type": "string" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfoRoot": { "required": [ @@ -42320,8 +43056,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "DocumentDirectories": { "type": "object", @@ -42340,8 +43075,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "DocumentDirectoriesRoot": { "required": [ @@ -42355,8 +43089,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "FIABIdentifier": { "required": [ @@ -42368,8 +43101,7 @@ "type": "string", "description": "User's FactSet account path." } - }, - "additionalProperties": false + } }, "FIABDateParameters": { "required": [ @@ -42387,7 +43119,6 @@ "description": "Calculation's end date." } }, - "additionalProperties": false, "description": "The date parameters for FIAB calculations." }, "FIABCalculationParameters": { @@ -42415,8 +43146,7 @@ "type": "string", "description": "FISettingsDocument (optional) - The given @FIS document will be used to\r\nconfigure analytics assumptions and settings. Expects a GUI-style path (Client:/foo/bar)" } - }, - "additionalProperties": false + } }, "FIABCalculationStatusSummary": { "type": "object", @@ -42431,8 +43161,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "EventSummary": { "type": "object", @@ -42450,8 +43179,7 @@ "type": "string", "description": "Event's type" } - }, - "additionalProperties": false + } }, "FIABCalculationStatus": { "type": "object", @@ -42494,8 +43222,7 @@ }, "description": "List of batch events" } - }, - "additionalProperties": false + } }, "FIReferencePrepay": { "type": "object", @@ -42504,8 +43231,7 @@ "type": "string", "description": "Reference Prepay Name" } - }, - "additionalProperties": false + } }, "FIReferenceSecurity": { "type": "object", @@ -42534,8 +43260,7 @@ "type": "string", "description": "Reference Settlement Date" } - }, - "additionalProperties": false + } }, "FIBankLoans": { "type": "object", @@ -42544,8 +43269,7 @@ "type": "boolean", "description": "Ignore Sinking Fund" } - }, - "additionalProperties": false + } }, "FIMunicipalBonds": { "type": "object", @@ -42558,8 +43282,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FILoss": { "type": "object", @@ -42568,8 +43291,7 @@ "type": "string", "description": "Loss Name" } - }, - "additionalProperties": false + } }, "FIPrepay": { "type": "object", @@ -42578,8 +43300,7 @@ "type": "string", "description": "Prepay Name" } - }, - "additionalProperties": false + } }, "FIServicerAdvancesForSecurities": { "type": "object", @@ -42605,8 +43326,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIPrepayLockout": { "type": "object", @@ -42629,8 +43349,7 @@ "type": "string", "description": "Ym Above" } - }, - "additionalProperties": false + } }, "FICashflows": { "type": "object", @@ -42657,8 +43376,7 @@ "description": "RecoveryLag", "format": "int32" } - }, - "additionalProperties": false + } }, "FIBalloonExtension": { "type": "object", @@ -42691,8 +43409,7 @@ "description": "Coupon Stepup", "format": "double" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForSecurities": { "type": "object", @@ -42721,8 +43438,42 @@ "balloonExtension": { "$ref": "#/components/schemas/FIBalloonExtension" } - }, - "additionalProperties": false + } + }, + "FIAttributionForSecurities": { + "type": "object", + "properties": { + "startPrice": { + "type": "number", + "description": "Start Price", + "format": "double" + }, + "endPrice": { + "type": "number", + "description": "End Price", + "format": "double" + }, + "startSpread": { + "type": "number", + "description": "Start Spread", + "format": "double" + }, + "endSpread": { + "type": "number", + "description": "End Spread", + "format": "double" + }, + "pricingMethod": { + "enum": [ + "Inputted Price", + "Pricing Matrix", + "Actual Spread", + "OAS" + ], + "type": "string", + "description": "Pricing Method" + } + } }, "FISecurity": { "required": [ @@ -42773,6 +43524,9 @@ "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForSecurities" }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForSecurities" + }, "calcFromMethod": { "type": "string", "description": "Calculation Method.\r\nMethods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" @@ -42805,8 +43559,7 @@ "type": "string", "description": "Discount curve" } - }, - "additionalProperties": false + } }, "FIMunicipalBondsForJobSettings": { "type": "object", @@ -42823,8 +43576,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FIMarketEnvironment": { "type": "object", @@ -42839,8 +43591,7 @@ "description": "Rate Path", "default": "FLAT & FORWARD" } - }, - "additionalProperties": false + } }, "FIServicerAdvances": { "type": "object", @@ -42856,8 +43607,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForJobSettings": { "type": "object", @@ -42886,8 +43636,20 @@ "balloonExtension": { "$ref": "#/components/schemas/FIBalloonExtension" } - }, - "additionalProperties": false + } + }, + "FIAttributionForJobSettings": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "description": "Start Date" + }, + "endDate": { + "type": "string", + "description": "End Date" + } + } }, "FIJobSettings": { "required": [ @@ -42936,9 +43698,11 @@ }, "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" + }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForJobSettings" } - }, - "additionalProperties": false + } }, "FICalculationParameters": { "required": [ @@ -42965,8 +43729,7 @@ "jobSettings": { "$ref": "#/components/schemas/FIJobSettings" } - }, - "additionalProperties": false + } }, "CalculationMeta": { "type": "object", @@ -43016,8 +43779,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "FICalculationParametersRoot": { "type": "object", @@ -43028,8 +43790,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PaDoc": { "required": [ @@ -43041,8 +43802,7 @@ "type": "string", "description": "PA document path" } - }, - "additionalProperties": false + } }, "FPOAccount": { "required": [ @@ -43060,8 +43820,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "FPOObjective": { "type": "object", @@ -43079,8 +43838,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategyOverrides": { "type": "object", @@ -43107,8 +43865,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategy": { "required": [ @@ -43123,8 +43880,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "FPOOptimizationParameters": { "required": [ @@ -43145,8 +43901,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "FPOOptimizationParametersRoot": { "type": "object", @@ -43157,8 +43912,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "Frequency": { "type": "object", @@ -43167,8 +43921,7 @@ "type": "string", "description": "Frequency name." } - }, - "additionalProperties": false + } }, "FrequencyRoot": { "required": [ @@ -43185,8 +43938,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Group": { "type": "object", @@ -43203,8 +43955,7 @@ "type": "string", "description": "Group Category" } - }, - "additionalProperties": false + } }, "GroupRoot": { "required": [ @@ -43221,8 +43972,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplateContentTypes": { "type": "object", @@ -43248,8 +43998,7 @@ }, "description": "Template locked fields" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParameters": { "required": [ @@ -43273,8 +44022,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParametersRoot": { "required": [ @@ -43288,8 +44036,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummary": { "type": "object", @@ -43310,8 +44057,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummaryRoot": { "required": [ @@ -43325,8 +44071,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummary": { "type": "object", @@ -43343,8 +44088,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummaryRoot": { "required": [ @@ -43361,8 +44105,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParameters": { "type": "object", @@ -43378,8 +44121,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParametersRoot": { "required": [ @@ -43393,8 +44135,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplate": { "type": "object", @@ -43426,8 +44167,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateRoot": { "required": [ @@ -43441,8 +44181,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategyOverrides": { "type": "object", @@ -43473,8 +44212,7 @@ "type": "string", "description": "Alpha" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategy": { "required": [ @@ -43489,8 +44227,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "NPOOptimizationParameters": { "required": [ @@ -43511,8 +44248,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "NPOOptimizationParametersRoot": { "type": "object", @@ -43523,8 +44259,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "PACalculationGroup": { "type": "object", @@ -43537,8 +44272,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "PACalculationColumn": { "type": "object", @@ -43554,8 +44288,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "PACalculationPricingSource": { "type": "object", @@ -43564,8 +44297,7 @@ "type": "string", "description": "Pricing source identifier" } - }, - "additionalProperties": false + } }, "PACalculationDataSources": { "type": "object", @@ -43588,8 +44320,7 @@ "type": "boolean", "description": "Use portfolio pricing sources for benchmark" } - }, - "additionalProperties": false + } }, "PACalculationParameters": { "required": [ @@ -43641,10 +44372,9 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." + "description": "Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "PACalculationParametersRoot": { "type": "object", @@ -43659,8 +44389,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationUnitStatus": { "type": "object", @@ -43695,9 +44424,15 @@ "type": "integer", "description": "The points for the calculation unit.", "format": "int32" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The warnings in a calculation unit." } - }, - "additionalProperties": false + } }, "CalculationStatus": { "type": "object", @@ -43723,8 +44458,7 @@ }, "description": "Number of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationUnitStatusMeta": { "type": "object", @@ -43733,8 +44467,7 @@ "type": "string", "description": "The Info URL of the calculation." } - }, - "additionalProperties": false + } }, "CalculationStatusMeta": { "type": "object", @@ -43746,8 +44479,7 @@ }, "description": "Meta of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationStatusRoot": { "required": [ @@ -43761,8 +44493,7 @@ "meta": { "$ref": "#/components/schemas/CalculationStatusMeta" } - }, - "additionalProperties": false + } }, "CalculationsSummary": { "type": "object", @@ -43792,8 +44523,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "PaginationInfo": { "type": "object", @@ -43820,8 +44550,7 @@ "previousPage": { "type": "string" } - }, - "additionalProperties": false + } }, "PaginationMeta": { "type": "object", @@ -43829,8 +44558,7 @@ "pagination": { "$ref": "#/components/schemas/PaginationInfo" } - }, - "additionalProperties": false + } }, "CalculationsSummaryRoot": { "required": [ @@ -43839,13 +44567,15 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CalculationsSummary" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CalculationsSummary" + } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } - }, - "additionalProperties": false + } }, "PAPricingSource": { "type": "object", @@ -43862,8 +44592,7 @@ "type": "string", "description": "Pricing source category" } - }, - "additionalProperties": false + } }, "PAPricingSourceRoot": { "required": [ @@ -43880,8 +44609,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "PubIdentifier": { "required": [ @@ -43897,8 +44625,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PubDateParameters": { "required": [ @@ -43915,7 +44642,6 @@ "description": "Calculation's end date or as of date." } }, - "additionalProperties": false, "description": "The date parameters for Publisher calculation." }, "PubCalculationParameters": { @@ -43936,12 +44662,10 @@ "dates": { "$ref": "#/components/schemas/PubDateParameters" } - }, - "additionalProperties": false + } }, "PubCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "PubCalculationParametersRoot": { "type": "object", @@ -43956,8 +44680,7 @@ "meta": { "$ref": "#/components/schemas/PubCalculationMeta" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverse": { "required": [ @@ -43984,8 +44707,7 @@ "securityExpr": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverse": { "required": [ @@ -44012,8 +44734,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantUniverse": { "required": [ @@ -44029,8 +44750,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverse": { "required": [ @@ -44046,8 +44766,7 @@ "screen": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantDateList": { "type": "object", @@ -44063,8 +44782,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantDate": { "required": [ @@ -44090,8 +44808,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantFdsDate": { "required": [ @@ -44111,8 +44828,7 @@ "endDate": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpression": { "required": [ @@ -44138,8 +44854,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameter": { "required": [ @@ -44159,8 +44874,7 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParameters": { "type": "object", @@ -44168,8 +44882,7 @@ { "$ref": "#/components/schemas/QuantFormula" } - ], - "additionalProperties": false + ] }, "QuantFormula": { "required": [ @@ -44186,8 +44899,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpression": { "required": [ @@ -44210,203 +44922,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionUniverseObsolete": { - "required": [ - "universeExpr", - "universeType" - ], - "type": "object", - "properties": { - "universeExpr": { - "type": "string" - }, - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "securityExpr": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantUniversalScreenUniverseObsolete": { - "required": [ - "screen" - ], - "type": "object", - "properties": { - "screen": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantIdentifierUniverseObsolete": { - "required": [ - "identifiers", - "universeType" - ], - "type": "object", - "properties": { - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "identifiers": { - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantFdsDateObsolete": { - "required": [ - "calendar", - "endDate", - "frequency", - "startDate" - ], - "type": "object", - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantDateListObsolete": { - "required": [ - "calendar", - "frequency" - ], - "type": "object", - "properties": { - "dates": { - "type": "array", - "items": { - "type": "string" - } - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantFqlExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - }, - "isArrayReturnType": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantUniversalScreenParameterObsolete": { - "required": [ - "name", - "referenceName" - ], - "type": "object", - "properties": { - "referenceName": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantAllUniversalScreenParametersObsolete": { - "type": "object", - "additionalProperties": false + } }, "OneOfQuantUniverse": { "oneOf": [ @@ -44492,8 +45008,7 @@ "jobDescription": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantCalculationMeta": { "type": "object", @@ -44546,8 +45061,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "QuantCalculationParametersRoot": { "type": "object", @@ -44562,8 +45076,7 @@ "meta": { "$ref": "#/components/schemas/QuantCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARDateParameters": { "required": [ @@ -44586,7 +45099,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for SPAR calculation." }, "SPARCalculationParameters": { @@ -44616,8 +45128,7 @@ "type": "string", "description": "Currency ISO code for calculation." } - }, - "additionalProperties": false + } }, "SPARCalculationParametersRoot": { "type": "object", @@ -44632,8 +45143,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PAComponentData": { "type": "object", @@ -44678,10 +45188,9 @@ }, "componentdetail": { "type": "string", - "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." } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParameters": { "required": [ @@ -44705,8 +45214,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParametersRoot": { "required": [ @@ -44720,8 +45228,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummary": { "type": "object", @@ -44741,8 +45248,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummaryRoot": { "required": [ @@ -44756,8 +45262,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummary": { "type": "object", @@ -44774,8 +45279,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummaryRoot": { "required": [ @@ -44792,8 +45296,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParameters": { "type": "object", @@ -44809,8 +45312,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParametersRoot": { "required": [ @@ -44824,8 +45326,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponent": { "type": "object", @@ -44854,8 +45355,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentRoot": { "required": [ @@ -44869,8 +45369,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParameters": { "required": [ @@ -44931,13 +45430,12 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParametersRoot": { "required": [ @@ -44951,8 +45449,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummary": { "type": "object", @@ -44973,8 +45470,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummaryRoot": { "required": [ @@ -44988,8 +45484,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummary": { "type": "object", @@ -45006,8 +45501,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummaryRoot": { "required": [ @@ -45024,8 +45518,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParameters": { "type": "object", @@ -45074,13 +45567,12 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParametersRoot": { "required": [ @@ -45094,8 +45586,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplate": { "type": "object", @@ -45156,7 +45647,7 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" @@ -45173,8 +45664,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateRoot": { "required": [ @@ -45188,8 +45678,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndType": { "type": "object", @@ -45202,8 +45691,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeRoot": { "required": [ @@ -45220,8 +45708,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateColumnDetails": { "type": "object", @@ -45241,8 +45728,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateGroupDetails": { "type": "object", @@ -45259,8 +45745,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetails": { "type": "object", @@ -45295,8 +45780,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { "required": [ @@ -45310,8 +45794,38 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } + }, + "VaultAttributionLoaderResponse": { + "type": "object", + "properties": { + "processId": { + "type": "string", + "description": "ProcessId." + }, + "groupId": { + "type": "string", + "description": "GroupId." + }, + "objectId": { + "type": "string", + "description": "ObjectId." + } + } + }, + "VaultAttributionLoaderResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/VaultAttributionLoaderResponse" + }, + "meta": { + "type": "object" + } + } }, "VaultCalculationParameters": { "required": [ @@ -45337,10 +45851,9 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." + "description": "Component detail type for the Vault component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "VaultCalculationParametersRoot": { "type": "object", @@ -45355,8 +45868,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } } }, "securitySchemes": { diff --git a/openapi-schema.json b/openapi-schema.json index 555651a..e0ab4c5 100644 --- a/openapi-schema.json +++ b/openapi-schema.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Engines API", - "description": "Allow clients to fetch Analytics through APIs.", + "description": "Allow clients to fetch Analytics through API.", "contact": { "name": "FactSet Research Systems", "url": "https://developer.factset.com/contact", @@ -351,12 +351,12 @@ { "name": "path", "in": "path", - "description": "The directory to get the accounts and sub-directories in", + "description": "The directory to get the accounts and sub-directories.", "required": true, "schema": { "type": "string", - "description": "The directory to get the accounts and sub-directories in", - "default": "" + "description": "The directory to get the accounts and sub-directories.", + "example": "Client:" } } ], @@ -671,9 +671,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -1089,9 +1090,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -2675,9 +2677,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -3093,9 +3096,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -4683,7 +4687,8 @@ "required": true, "schema": { "type": "string", - "description": "Benchmark Identifier" + "description": "Benchmark Identifier", + "example": "R.1000" } } ], @@ -4998,9 +5003,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -5416,9 +5422,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -7006,7 +7013,8 @@ "schema": { "type": "string", "description": "Column name", - "default": "" + "default": "", + "example": "Security Name" } }, { @@ -7026,7 +7034,8 @@ "schema": { "type": "string", "description": "The directory to get the columns in", - "default": "" + "default": "", + "example": "Client" } } ], @@ -7264,7 +7273,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a column" + "description": "Unique identifier for a column", + "example": "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7" } } ], @@ -7809,7 +7819,8 @@ "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Document Name", + "example": "PA3_DOCUMENTS:DEFAULT" } } ], @@ -8128,7 +8139,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a PA component" + "description": "Unique identifier for a PA component", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" } } ], @@ -8447,7 +8459,8 @@ "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Document Name", + "example": "SPAR_DOCUMENTS:Factset Default Document" } } ], @@ -8750,29 +8763,30 @@ ] } }, - "/analytics/engines/vault/v3/components": { + "/analytics/engines/spar/v3/components/{id}": { "get": { "tags": [ "Components" ], - "summary": "Get Vault components", - "description": "This endpoint returns the list of Vault components in a given Vault document.", - "operationId": "getVaultComponents", + "summary": "Get SPAR component by id", + "description": "This endpoint returns the default settings of a SPAR component.", + "operationId": "getSPARComponentById", "parameters": [ { - "name": "document", - "in": "query", - "description": "Document Name", + "name": "id", + "in": "path", + "description": "Unique identifier for a SPAR component", "required": true, "schema": { "type": "string", - "description": "Document Name" + "description": "Unique identifier for a SPAR component", + "example": "067F5DE2E2A11F9AD734594AA8957E11B633438D0FADFCCE0F423ABEF2FC5F1D" } } ], "responses": { "200": { - "description": "Expected response, returns a list of Vault components.", + "description": "Expected response, returns the default settings of a SPAR component.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -8810,13 +8824,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ComponentSummaryRoot" + "$ref": "#/components/schemas/SPARComponentRoot" } } } }, "400": { - "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.", @@ -8860,7 +8874,7 @@ } }, "404": { - "description": "Vault Document not found.", + "description": "Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9064,34 +9078,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "ComponentSummaryRoot" + "response-type": "SPARComponentRoot" } ] } }, - "/analytics/engines/vault/v3/components/{id}": { + "/analytics/engines/vault/v3/components": { "get": { "tags": [ "Components" ], - "summary": "Get Vault component by id", - "description": "This endpoint returns the default settings of a Vault component.", - "operationId": "getVaultComponentById", + "summary": "Get Vault components", + "description": "This endpoint returns the list of Vault components in a given Vault document.", + "operationId": "getVaultComponents", "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for a vault component", + "name": "document", + "in": "query", + "description": "Document Name", "required": true, "schema": { "type": "string", - "description": "Unique identifier for a vault component" + "description": "Document Name" } } ], "responses": { "200": { - "description": "Expected response, returns the default settings of a Vault component.", + "description": "Expected response, returns a list of Vault components.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9129,13 +9143,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultComponentRoot" + "$ref": "#/components/schemas/ComponentSummaryRoot" } } } }, "400": { - "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.", @@ -9179,7 +9193,7 @@ } }, "404": { - "description": "Vault Component not found.", + "description": "Vault Document not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9383,34 +9397,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultComponentRoot" + "response-type": "ComponentSummaryRoot" } ] } }, - "/analytics/engines/vault/v3/configurations": { + "/analytics/engines/vault/v3/components/{id}": { "get": { "tags": [ - "Configurations" + "Components" ], - "summary": "Get Vault configurations", - "description": "This endpoint returns all the Vault configurations saved in the provided account.", - "operationId": "getVaultConfigurations", + "summary": "Get Vault component by id", + "description": "This endpoint returns the default settings of a Vault component.", + "operationId": "getVaultComponentById", "parameters": [ { - "name": "account", - "in": "query", - "description": "Required account query parameter to filter configurations for a specific account", + "name": "id", + "in": "path", + "description": "Unique identifier for a vault component", "required": true, "schema": { "type": "string", - "description": "Required account query parameter to filter configurations for a specific account" + "description": "Unique identifier for a vault component" } } ], "responses": { "200": { - "description": "Expected response, returns a dictionary of Vault configurations.", + "description": "Expected response, returns the default settings of a Vault component.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9448,13 +9462,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" + "$ref": "#/components/schemas/VaultComponentRoot" } } } }, "400": { - "description": "Invalid account.", + "description": "Invalid Vault component id.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9498,7 +9512,7 @@ } }, "404": { - "description": "Account not found.", + "description": "Vault Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9702,34 +9716,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultConfigurationSummaryRoot" + "response-type": "VaultComponentRoot" } ] } }, - "/analytics/engines/vault/v3/configurations/{id}": { + "/analytics/engines/vault/v3/configurations": { "get": { "tags": [ "Configurations" ], - "summary": "Get Vault configuration by id", - "description": "This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.", - "operationId": "getVaultConfigurationById", + "summary": "Get Vault configurations", + "description": "This endpoint returns all the Vault configurations saved in the provided account.", + "operationId": "getVaultConfigurations", "parameters": [ { - "name": "id", - "in": "path", - "description": "Vault configuration id to get the details of", + "name": "account", + "in": "query", + "description": "Required account query parameter to filter configurations for a specific account", "required": true, "schema": { "type": "string", - "description": "Vault configuration id to get the details of" + "description": "Required account query parameter to filter configurations for a specific account" } } ], "responses": { "200": { - "description": "Expected response, returns details for a Vault configuration.", + "description": "Expected response, returns a dictionary of Vault configurations.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9767,13 +9781,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultConfigurationRoot" + "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" } } } }, "400": { - "description": "Invalid vault configuration code.", + "description": "Invalid account.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9817,7 +9831,7 @@ } }, "404": { - "description": "Vault configuration id not found.", + "description": "Account not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -10021,22 +10035,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "VaultConfigurationRoot" + "response-type": "VaultConfigurationSummaryRoot" } ] } }, - "/analytics/lookups/v3/currencies": { + "/analytics/engines/vault/v3/configurations/{id}": { "get": { "tags": [ - "Currencies" + "Configurations" + ], + "summary": "Get Vault configuration by id", + "description": "This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.", + "operationId": "getVaultConfigurationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Vault configuration id to get the details of", + "required": true, + "schema": { + "type": "string", + "description": "Vault configuration id to get the details of" + } + } ], - "summary": "Get currencies", - "description": "This endpoint lists all the currencies that can be applied to any calculation.", - "operationId": "getCurrencies", "responses": { "200": { - "description": "Expected response, returns a list of currencies.", + "description": "Expected response, returns details for a Vault configuration.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -10074,7 +10100,95 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyRoot" + "$ref": "#/components/schemas/VaultConfigurationRoot" + } + } + } + }, + "400": { + "description": "Invalid vault configuration code.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Vault configuration id not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" } } } @@ -10240,63 +10354,286 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "CurrencyRoot" + "response-type": "VaultConfigurationRoot" } ] } }, - "/analytics/engines/pa/v3/dates": { + "/analytics/lookups/v3/currencies": { "get": { "tags": [ - "Dates" - ], - "summary": "Convert PA dates to absolute format", - "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": [ - { - "name": "startdate", - "in": "query", - "description": "Start Date", - "schema": { - "type": "string", - "description": "Start Date" - } - }, - { - "name": "enddate", - "in": "query", - "description": "End Date", - "required": true, - "schema": { - "type": "string", - "description": "End Date" - } - }, - { - "name": "componentid", - "in": "query", - "description": "Component Id", - "required": true, - "schema": { - "type": "string", - "description": "Component Id" - } - }, - { - "name": "account", - "in": "query", - "description": "Account", - "required": true, - "schema": { - "type": "string", - "description": "Account" - } - } + "Currencies" ], + "summary": "Get currencies", + "description": "This endpoint lists all the currencies that can be applied to any calculation.", + "operationId": "getCurrencies", "responses": { "200": { - "description": "Expected response, returns the converted dates in yyyymmdd format.", + "description": "Expected response, returns a list of currencies.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyRoot" + } + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "403": { + "description": "User is forbidden with current credentials", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CurrencyRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/dates": { + "get": { + "tags": [ + "Dates" + ], + "summary": "Convert PA dates to absolute format", + "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": [ + { + "name": "startdate", + "in": "query", + "description": "Start Date", + "schema": { + "type": "string", + "description": "Start Date", + "example": "-3AY" + } + }, + { + "name": "enddate", + "in": "query", + "description": "End Date", + "required": true, + "schema": { + "type": "string", + "description": "End Date", + "example": "-1AY" + } + }, + { + "name": "componentid", + "in": "query", + "description": "Component Id", + "required": true, + "schema": { + "type": "string", + "description": "Component Id", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" + } + }, + { + "name": "account", + "in": "query", + "description": "Account ( Account Name ending with .ACCT or .ACTM )", + "required": true, + "schema": { + "type": "string", + "description": "Account ( Account Name ending with .ACCT or .ACTM )", + "example": "Client:/Folder1/Folder2/AccountName.ACCT" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the converted dates in yyyymmdd format.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11230,7 +11567,7 @@ "schema": { "type": "string", "description": "The directory to get the documents and sub-directories in", - "default": "" + "example": "Client:" } } ], @@ -11550,7 +11887,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -11870,7 +12207,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -12190,7 +12527,7 @@ "schema": { "type": "string", "description": "The directory to get the documents in", - "default": "" + "example": "Client:" } } ], @@ -13489,9 +13826,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -14067,9 +14405,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -15708,9 +16047,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -16126,9 +16466,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -19134,7 +19475,8 @@ "description": "Get linked PA templates in path.", "schema": { "type": "string", - "description": "Get linked PA templates in path." + "description": "Get linked PA templates in path.", + "example": "Personal:LinkedPATemplates/" } }, { @@ -19471,7 +19813,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -19799,7 +20142,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -20129,7 +20473,8 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a linked PA template" + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } ], @@ -20444,9 +20789,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -20862,9 +21208,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds.", + "description": "Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -22442,15 +22789,16 @@ "PACalculations" ], "summary": "Create and Run PA calculation", - "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.", + "description": "This endpoint runs the PA calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. \r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "postAndCalculate", "parameters": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -22927,7 +23275,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -23240,7 +23587,7 @@ "PACalculations" ], "summary": "Create or Update PA calculation and run it.", - "description": "This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "description": "This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "putAndCalculate", "parameters": [ { @@ -23256,9 +23603,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -25319,9 +25667,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -25801,7 +26150,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -26130,9 +26478,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -28275,6 +28624,55 @@ } } }, + "413": { + "description": "Request body too large", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -28477,7 +28875,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -29124,6 +29521,55 @@ } } }, + "413": { + "description": "Request body too large", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -30856,9 +31302,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -31335,7 +31782,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -31664,9 +32110,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -31882,18 +32329,392 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "One or more calculation settings were unavailable.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "403": { + "description": "User is forbidden with current credentials", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + } + }, + "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" + } + ] + }, + "get": { + "tags": [ + "SPARCalculations" + ], + "summary": "Get SPAR calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the SPAR calculation parameters.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SPARCalculationParametersRoot" } } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31933,16 +32754,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, - "409": { - "description": "Duplicate calculation exists with same parameters.", + "404": { + "description": "Calculation id not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31982,11 +32798,6 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -32046,88 +32857,8 @@ } } }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", + "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.", @@ -32165,29 +32896,21 @@ } } }, - "x-are-multiple-success-responses-different": true, + "x-are-multiple-success-responses-different": false, "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, { "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" + "response-type": "SPARCalculationParametersRoot" } ] }, - "get": { + "delete": { "tags": [ "SPARCalculations" ], - "summary": "Get SPAR calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", + "summary": "Cancel SPAR calculation", + "description": "This is the endpoint to cancel a previously submitted calculation.", + "operationId": "cancelCalculationById", "parameters": [ { "name": "id", @@ -32201,30 +32924,9 @@ } ], "responses": { - "200": { - "description": "Expected response, returns the SPAR calculation parameters.", + "204": { + "description": "Expected response, calculation was canceled successfully.", "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -32257,13 +32959,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SPARCalculationParametersRoot" - } - } } }, "400": { @@ -32303,15 +32998,25 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, "404": { - "description": "Calculation id not found", + "description": "There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32347,10 +33052,20 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -32411,7 +33126,7 @@ } }, "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", + "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.", @@ -32452,18 +33167,20 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "SPARCalculationParametersRoot" + "status-code": "204", + "response-type": null } ] - }, - "delete": { + } + }, + "/analytics/engines/spar/v3/calculations/{id}/status": { + "get": { "tags": [ "SPARCalculations" ], - "summary": "Cancel SPAR calculation", - "description": "This is the endpoint to cancel a previously submitted calculation.", - "operationId": "cancelCalculationById", + "summary": "Get SPAR calculation status by id", + "description": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.", + "operationId": "getCalculationStatusById", "parameters": [ { "name": "id", @@ -32477,9 +33194,30 @@ } ], "responses": { - "204": { - "description": "Expected response, calculation was canceled successfully.", + "200": { + "description": "Expected response once calculation is completed.", "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -32512,11 +33250,32 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } } }, - "400": { - "description": "Invalid identifier provided.", + "202": { + "description": "Expected response returned if the calculation is not yet completed.", "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "schema": { + "type": "string", + "description": "FactSet's progress header." + } + }, + "Cache-Control": { + "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.", + "schema": { + "type": "integer", + "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value." + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -32551,25 +33310,15 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/CalculationStatusRoot" } } } }, - "404": { - "description": "There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier.", + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32605,17 +33354,51 @@ } }, "content": { - "text/plain": { + "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + } + } + }, + "404": { + "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } }, - "application/json": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } }, - "text/json": { + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } @@ -32679,7 +33462,7 @@ } }, "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", + "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.", @@ -32720,35 +33503,49 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" } ] } }, - "/analytics/engines/spar/v3/calculations/{id}/status": { + "/analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result": { "get": { "tags": [ "SPARCalculations" ], - "summary": "Get SPAR calculation status by id", - "description": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.", - "operationId": "getCalculationStatusById", + "summary": "Get SPAR calculation result by id", + "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": [ { "name": "id", "in": "path", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint", + "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint", "required": true, "schema": { "type": "string", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" + "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" + } + }, + { + "name": "unitId", + "in": "path", + "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" } } ], "responses": { "200": { - "description": "Expected response once calculation is completed.", + "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.", @@ -32807,65 +33604,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - } - } - }, - "202": { - "description": "Expected response returned if the calculation is not yet completed.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "schema": { - "type": "string", - "description": "FactSet's progress header." - } - }, - "Cache-Control": { - "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.", - "schema": { - "type": "integer", - "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "$ref": "#/components/schemas/ObjectRoot" } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { + "application/x-protobuf": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/ObjectRoot" } } } @@ -32911,6 +33655,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -32955,6 +33704,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -33057,70 +33811,36 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "202", - "response-type": "CalculationStatusRoot" + "response-type": "ObjectRoot" } ] } }, - "/analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result": { + "/analytics/engines/axp/v3/strategies/{path}": { "get": { "tags": [ - "SPARCalculations" + "StrategyDocuments" ], - "summary": "Get SPAR calculation result by id", - "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", + "summary": "Get Axioma Equity strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory.", + "operationId": "getAxiomaEquityStrategyDocuments", "parameters": [ { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" - } - }, - { - "name": "unitId", + "name": "path", "in": "path", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint", + "description": "The directory to get the strategy documents and sub-directories in", "required": true, "schema": { "type": "string", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" + "description": "The directory to get the strategy documents and sub-directories in", + "example": "Client:" } } ], "responses": { "200": { - "description": "Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters.", + "description": "Expected response, returns a list of Axioma Equity strategy documents and directories", "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -33157,67 +33877,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$ref": "#/components/schemas/DocumentDirectoriesRoot" } } } }, "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "description": "Invalid query parameter or value provided", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33257,8 +33923,47 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } }, - "application/x-protobuf": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } @@ -33266,7 +33971,7 @@ } }, "401": { - "description": "Missing or invalid authentication.", + "description": "Missing or invalid authentication", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33321,6 +34026,68 @@ } } }, + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + } + }, + "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } + } + } + }, "500": { "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", "headers": { @@ -33341,7 +34108,7 @@ } }, "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.", @@ -33364,19 +34131,19 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "ObjectRoot" + "response-type": "DocumentDirectoriesRoot" } ] } }, - "/analytics/engines/axp/v3/strategies/{path}": { + "/analytics/engines/afi/v3/strategies/{path}": { "get": { "tags": [ "StrategyDocuments" ], - "summary": "Get Axioma Equity strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory.", - "operationId": "getAxiomaEquityStrategyDocuments", + "summary": "Get Axioma FI strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory.", + "operationId": "getAxiomaFIStrategyDocuments", "parameters": [ { "name": "path", @@ -33386,13 +34153,13 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], "responses": { "200": { - "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.", @@ -33689,14 +34456,14 @@ ] } }, - "/analytics/engines/afi/v3/strategies/{path}": { + "/analytics/engines/bpm/v3/strategies/{path}": { "get": { "tags": [ "StrategyDocuments" ], - "summary": "Get Axioma FI strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory.", - "operationId": "getAxiomaFIStrategyDocuments", + "summary": "Get Barra strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all Barra strategy documents and sub-directories in a given directory.", + "operationId": "getBarraStrategyDocuments", "parameters": [ { "name": "path", @@ -33706,13 +34473,13 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], "responses": { "200": { - "description": "Expected response, returns a list of Axioma FI strategy documents and directories", + "description": "Expected response, returns a list of Barra strategy documents and directories", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34009,14 +34776,14 @@ ] } }, - "/analytics/engines/bpm/v3/strategies/{path}": { + "/analytics/engines/npo/v3/strategies/{path}": { "get": { "tags": [ "StrategyDocuments" ], - "summary": "Get Barra strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all Barra strategy documents and sub-directories in a given directory.", - "operationId": "getBarraStrategyDocuments", + "summary": "Get Northfield strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all Northfield strategy documents and sub-directories in a given directory.", + "operationId": "getNorthfieldStrategyDocuments", "parameters": [ { "name": "path", @@ -34026,13 +34793,13 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], "responses": { "200": { - "description": "Expected response, returns a list of Barra strategy documents and directories", + "description": "Expected response, returns a list of Northfield strategy documents and directories", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34329,14 +35096,14 @@ ] } }, - "/analytics/engines/npo/v3/strategies/{path}": { + "/analytics/engines/fpo/v3/strategies/{path}": { "get": { "tags": [ "StrategyDocuments" ], - "summary": "Get Northfield strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all Northfield strategy documents and sub-directories in a given directory.", - "operationId": "getNorthfieldStrategyDocuments", + "summary": "Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory.", + "operationId": "getFPOStrategyDocuments", "parameters": [ { "name": "path", @@ -34346,13 +35113,13 @@ "schema": { "type": "string", "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "example": "Client:" } } ], "responses": { "200": { - "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.", @@ -34649,30 +35416,28 @@ ] } }, - "/analytics/engines/fpo/v3/strategies/{path}": { - "get": { + "/analytics/engines/pa/v3/templated-components": { + "post": { "tags": [ - "StrategyDocuments" + "TemplatedPAComponents" ], - "summary": "Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory.", - "operationId": "getFPOStrategyDocuments", - "parameters": [ - { - "name": "path", - "in": "path", - "description": "The directory to get the strategy documents and sub-directories in", - "required": true, - "schema": { - "type": "string", - "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "summary": "Create templated PA component", + "description": "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "createTemplatedPAComponents", + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentParametersRoot" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { - "description": "Expected response, returns a list of FactSet Portfolio Optimizer strategy documents and directories", + "201": { + "description": "Expected response, templated PA component created successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34708,15 +35473,25 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } } } }, "400": { - "description": "Invalid query parameter or value provided", + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34752,15 +35527,44 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "404": { - "description": "Path not found", + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34794,36 +35598,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "401": { - "description": "Missing or invalid authentication", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", + "404": { + "description": "Template not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34860,7 +35638,7 @@ } }, "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.", @@ -34922,7 +35700,7 @@ } }, "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", + "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.", @@ -34941,7 +35719,7 @@ } }, "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.", @@ -34963,34 +35741,34 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "DocumentDirectoriesRoot" + "status-code": "201", + "response-type": "TemplatedPAComponentPostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/templated-components": { - "post": { + }, + "get": { "tags": [ "TemplatedPAComponents" ], - "summary": "Create templated PA component", - "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": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentParametersRoot" - } + "summary": "Get templated PA components in path", + "description": "This endpoint returns the list of templated PA components in path.", + "operationId": "getTemplatedPAComponentsInPath", + "parameters": [ + { + "name": "directory", + "in": "query", + "description": "Get templated PA components in path", + "required": true, + "schema": { + "type": "string", + "description": "Get templated PA components in path", + "example": "Personal:TemplatedPAComponents/" } - }, - "required": true - }, + } + ], "responses": { - "201": { - "description": "Expected response, templated PA component created successfully.", + "200": { + "description": "Expected response, returns a list templated PA components.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35026,19 +35804,9 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" } } } @@ -35080,20 +35848,10 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -35153,43 +35911,6 @@ } } }, - "404": { - "description": "Template not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, "406": { "description": "Unsupported Accept header. Header needs to be set to application/json.", "headers": { @@ -35294,33 +36015,47 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "201", - "response-type": "TemplatedPAComponentPostSummaryRoot" + "status-code": "200", + "response-type": "TemplatedPAComponentSummaryRoot" } ] - }, - "get": { + } + }, + "/analytics/engines/pa/v3/templated-components/{id}": { + "put": { "tags": [ "TemplatedPAComponents" ], - "summary": "Get templated PA components in path", - "description": "This endpoint returns the list of templated PA components in path.", - "operationId": "getTemplatedPAComponentsInPath", + "summary": "Update templated PA component", + "description": "This endpoint allows the user to change the request body from an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "updateTemplatedPAComponents", "parameters": [ { - "name": "directory", - "in": "query", - "description": "Get templated PA components in path", + "name": "id", + "in": "path", + "description": "Unique identifier for a templated PA component", "required": true, "schema": { "type": "string", - "description": "Get templated PA components in path" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Expected response, returns a list templated PA components.", + "description": "Expected response, updated successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35358,7 +36093,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } } } @@ -35407,6 +36142,50 @@ } } }, + "404": { + "description": "Component or template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -35568,19 +36347,17 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "TemplatedPAComponentSummaryRoot" + "response-type": "TemplatedPAComponentPostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/templated-components/{id}": { - "put": { + }, + "get": { "tags": [ "TemplatedPAComponents" ], - "summary": "Update templated PA component", - "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", + "summary": "Get templated PA component by id", + "description": "This endpoint fetches the templated PA component settings.", + "operationId": "getTemplatedPAComponentById", "parameters": [ { "name": "id", @@ -35589,24 +36366,14 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" - } - } - }, - "required": true - }, "responses": { "200": { - "description": "Expected response, updated successfully.", + "description": "Expected response, templated PA component details.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35644,7 +36411,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentRoot" } } } @@ -35694,7 +36461,7 @@ } }, "404": { - "description": "Component or template not found.", + "description": "Templated PA component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35898,17 +36665,17 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "TemplatedPAComponentPostSummaryRoot" + "response-type": "TemplatedPAComponentRoot" } ] }, - "get": { + "delete": { "tags": [ "TemplatedPAComponents" ], - "summary": "Get templated PA component by id", - "description": "This endpoint fetches the templated PA component settings.", - "operationId": "getTemplatedPAComponentById", + "summary": "Delete templated PA component", + "description": "This endpoint deletes an existing templated PA component", + "operationId": "deleteTemplatedPAComponents", "parameters": [ { "name": "id", @@ -35917,13 +36684,14 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" } } ], "responses": { - "200": { - "description": "Expected response, templated PA component details.", + "204": { + "description": "Expected response, deleted the templated PA component successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35957,13 +36725,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentRoot" - } - } } }, "400": { @@ -36003,15 +36764,25 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, "404": { - "description": "Templated PA component not found.", + "description": "Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36047,10 +36818,20 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -36214,70 +36995,34 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "TemplatedPAComponentRoot" + "status-code": "204", + "response-type": null } ] - }, - "delete": { + } + }, + "/analytics/engines/pa/v3/unlinked-templates": { + "post": { "tags": [ - "TemplatedPAComponents" - ], - "summary": "Delete templated PA component", - "description": "This endpoint deletes an existing templated PA component", - "operationId": "deleteTemplatedPAComponents", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a templated PA component", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a templated PA component" - } - } + "UnlinkedPATemplates" ], - "responses": { - "204": { - "description": "Expected response, deleted the templated PA component successfully.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } + "summary": "Create unlinked PA template", + "description": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also \r\n overriding the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "createUnlinkedPATemplates", + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" } } }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "required": true + }, + "responses": { + "201": { + "description": "Expected response, created a unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36313,25 +37058,15 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } }, - "404": { - "description": "Component not found.", + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36367,20 +37102,10 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -36544,34 +37269,43 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "201", + "response-type": "UnlinkedPATemplatePostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates": { - "post": { + }, + "get": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Create unlinked PA template", - "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": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" - } + "summary": "Get unlinked PA templates", + "description": "This endpoint returns the list of unlinked PA templates.", + "operationId": "getUnlinkedPATemplates", + "parameters": [ + { + "name": "directory", + "in": "query", + "description": "Get unlinked PA templates in path.", + "schema": { + "type": "string", + "description": "Get unlinked PA templates in path.", + "example": "Personal:UninkedPATemplates/" } }, - "required": true - }, + { + "name": "category", + "in": "query", + "description": "Get unlinked PA templates by category.", + "schema": { + "type": "string", + "description": "Get unlinked PA templates by category.", + "example": "Weights" + } + } + ], "responses": { - "201": { - "description": "Expected response, created a unlinked PA template.", + "200": { + "description": "Expected response, returns a list of unlinked PA templates.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36609,7 +37343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" } } } @@ -36818,41 +37552,47 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "201", - "response-type": "UnlinkedPATemplatePostSummaryRoot" + "status-code": "200", + "response-type": "UnlinkedPATemplateSummaryRoot" } ] - }, - "get": { + } + }, + "/analytics/engines/pa/v3/unlinked-templates/{id}": { + "put": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Get unlinked PA templates", - "description": "This endpoint returns the list of unlinked PA templates.", - "operationId": "getUnlinkedPATemplates", + "summary": "Update unlinked PA template", + "description": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "updateUnlinkedPATemplates", "parameters": [ { - "name": "directory", - "in": "query", - "description": "Get unlinked PA templates in path.", - "schema": { - "type": "string", - "description": "Get unlinked PA templates in path." - } - }, - { - "name": "category", - "in": "query", - "description": "Get unlinked PA templates by category.", + "name": "id", + "in": "path", + "description": "Unique identifier for an unlinked PA template", + "required": true, "schema": { "type": "string", - "description": "Get unlinked PA templates by category." + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Expected response, returns a list of unlinked PA templates.", + "description": "Expected response, updated the unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36890,7 +37630,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } @@ -36939,6 +37679,50 @@ } } }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -37100,19 +37884,17 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateSummaryRoot" + "response-type": "UnlinkedPATemplatePostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates/{id}": { - "put": { + }, + "delete": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Update unlinked PA template", - "description": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* 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", + "summary": "Delete unlinked PA template", + "description": "This endpoint deletes an existing unliked PA template.", + "operationId": "deleteUnlinkedPATemplates", "parameters": [ { "name": "id", @@ -37121,24 +37903,14 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" - } - } - }, - "required": true - }, "responses": { - "200": { - "description": "Expected response, updated the unlinked PA template.", + "204": { + "description": "Expected response, deleted the unlinked PA template successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37172,13 +37944,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" - } - } } }, "400": { @@ -37429,18 +38194,18 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "UnlinkedPATemplatePostSummaryRoot" + "status-code": "204", + "response-type": null } ] }, - "delete": { + "get": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Delete unlinked PA template", - "description": "This endpoint deletes an existing unliked PA template.", - "operationId": "deleteUnlinkedPATemplates", + "summary": "Get unlinked PA template details by id", + "description": "This endpoint fetches the template settings.", + "operationId": "getUnlinkedPATemplatesById", "parameters": [ { "name": "id", @@ -37449,13 +38214,14 @@ "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Unique identifier for an unlinked PA template", + "example": "01234567890123456789012345678901" } } ], "responses": { - "204": { - "description": "Expected response, deleted the unlinked PA template successfully.", + "200": { + "description": "Expected response, get details of the unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37489,6 +38255,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateRoot" + } + } } }, "400": { @@ -37739,121 +38512,23 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "UnlinkedPATemplateRoot" } ] - }, + } + }, + "/analytics/engines/pa/v3/unlinked-templates/template-types": { "get": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Get unlinked PA template details by id", - "description": "This endpoint fetches the template settings.", - "operationId": "getUnlinkedPATemplatesById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for an unlinked PA template", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for an unlinked PA template" - } - } - ], + "summary": "Get default unlinked PA template types.", + "description": "This endpoint fetches default unlinked PA template types.", + "operationId": "getDefaultUnlinkedPATemplateTypes", "responses": { "200": { - "description": "Expected response, get details of the unlinked PA template.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateRoot" - } - } - } - }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Template not found.", + "description": "Expected response, default unlinked PA template types", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37891,7 +38566,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" } } } @@ -38057,22 +38732,34 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateRoot" + "response-type": "UnlinkedPATemplateCategoryAndTypeRoot" } ] } }, - "/analytics/engines/pa/v3/unlinked-templates/template-types": { + "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}": { "get": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Get default unlinked PA template types.", - "description": "This endpoint fetches default unlinked PA template types.", - "operationId": "getDefaultUnlinkedPATemplateTypes", + "summary": "Get unlinked PA template type details by id.", + "description": "This endpoint fetches the unlinked PA template type details.", + "operationId": "getDetailsType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for an unlinked PA template type", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for an unlinked PA template type" + } + } + ], "responses": { "200": { - "description": "Expected response, default unlinked PA template types", + "description": "Expected response, details of the unlinked PA template type", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -38110,7 +38797,95 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + } + } + } + }, + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Unlinked PA template type not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" } } } @@ -38276,78 +39051,53 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeRoot" + "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" } ] } }, - "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}": { - "get": { + "/analytics/engines/vault/v3/load/{batchId}": { + "post": { "tags": [ - "UnlinkedPATemplates" + "Vault Attribution Loader" ], - "summary": "Get unlinked PA template type details by id.", - "description": "This endpoint fetches the unlinked PA template type details.", - "operationId": "getDetailsType", + "summary": "Vault - External Attribution Loader", + "description": "This endpoint loads Vault External Attributions.", + "operationId": "vaultAttributionLoader", "parameters": [ { - "name": "id", + "name": "batchId", "in": "path", - "description": "Unique identifier for an unlinked PA template type", "required": true, "schema": { - "type": "string", - "description": "Unique identifier for an unlinked PA template type" + "type": "string" } } ], - "responses": { - "200": { - "description": "Expected response, details of the unlinked PA template type", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "nullable": true + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "encoding": { + "file": { + "style": "form" } } } - }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + } + }, + "responses": { + "200": { + "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.", @@ -38385,13 +39135,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/VaultAttributionLoaderResponseRoot" } } } }, - "404": { - "description": "Unlinked PA template type not found.", + "400": { + "description": "Bad Request", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -38595,7 +39345,7 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "response-type": "VaultAttributionLoaderResponseRoot" } ] } @@ -38612,9 +39362,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -39091,7 +39842,6 @@ { "name": "pageNumber", "in": "query", - "required": true, "schema": { "type": "integer", "format": "int32", @@ -39420,9 +40170,10 @@ { "name": "X-FactSet-Api-Long-Running-Deadline", "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the PUT body.", + "description": "Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.", "schema": { - "type": "integer" + "type": "integer", + "example": "10" } }, { @@ -41137,8 +41888,7 @@ "id": { "type": "string" } - }, - "additionalProperties": false + } }, "SPARAccounts": { "type": "object", @@ -41150,8 +41900,7 @@ }, "description": "List of SPAR returnsType" } - }, - "additionalProperties": false + } }, "SPARAccountsRoot": { "required": [ @@ -41163,8 +41912,7 @@ "$ref": "#/components/schemas/SPARAccounts" }, "meta": { } - }, - "additionalProperties": false + } }, "ErrorSource": { "type": "object", @@ -41175,8 +41923,7 @@ "parameter": { "type": "string" } - }, - "additionalProperties": false + } }, "Error": { "type": "object", @@ -41184,14 +41931,19 @@ "id": { "type": "string" }, + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, "detail": { "type": "string" }, "source": { "$ref": "#/components/schemas/ErrorSource" } - }, - "additionalProperties": false + } }, "ClientErrorResponse": { "type": "object", @@ -41202,8 +41954,7 @@ "$ref": "#/components/schemas/Error" } } - }, - "additionalProperties": false + } }, "AccountDirectories": { "type": "object", @@ -41222,8 +41973,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "AccountDirectoriesRoot": { "required": [ @@ -41235,8 +41985,7 @@ "$ref": "#/components/schemas/AccountDirectories" }, "meta": { } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategyOverrides": { "type": "object", @@ -41268,8 +42017,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategy": { "required": [ @@ -41284,8 +42032,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "OptimizerAccountOverrides": { "type": "object", @@ -41306,8 +42053,7 @@ "type": "string", "description": "Currency" } - }, - "additionalProperties": false + } }, "OptimizerAccount": { "type": "object", @@ -41319,8 +42065,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "Optimization": { "type": "object", @@ -41337,8 +42082,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "OptimizerTradesList": { "type": "object", @@ -41363,8 +42107,7 @@ "type": "boolean", "description": "Include cash" } - }, - "additionalProperties": false + } }, "OptimizerOptimalHoldings": { "type": "object", @@ -41393,8 +42136,7 @@ "type": "boolean", "description": "Exclude zero" } - }, - "additionalProperties": false + } }, "OptimalPortfolio": { "type": "object", @@ -41429,12 +42171,10 @@ "type": "string", "description": "Action if ofdb date exists" } - }, - "additionalProperties": false + } }, "OptimizerStats": { - "type": "object", - "additionalProperties": false + "type": "object" }, "OptimizerOutputTypes": { "type": "object", @@ -41451,8 +42191,7 @@ "stats": { "$ref": "#/components/schemas/OptimizerStats" } - }, - "additionalProperties": false + } }, "AFIOptimizationParameters": { "required": [ @@ -41473,12 +42212,10 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "OptimizerCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "AFIOptimizationParametersRoot": { "type": "object", @@ -41489,8 +42226,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationInfo": { "type": "object", @@ -41499,8 +42235,7 @@ "type": "string", "description": "Calculation identifier" } - }, - "additionalProperties": false + } }, "CalculationInfoRoot": { "required": [ @@ -41512,8 +42247,7 @@ "$ref": "#/components/schemas/CalculationInfo" }, "meta": { } - }, - "additionalProperties": false + } }, "ObjectRoot": { "required": [ @@ -41523,8 +42257,7 @@ "properties": { "data": { }, "meta": { } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategyOverrides": { "type": "object", @@ -41556,8 +42289,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategy": { "required": [ @@ -41572,8 +42304,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParameters": { "required": [ @@ -41594,8 +42325,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParametersRoot": { "type": "object", @@ -41606,8 +42336,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARIdentifier": { "required": [ @@ -41621,14 +42350,13 @@ }, "returntype": { "type": "string", - "description": "Benchmark return type." + "description": "Account or benchmark return type." }, "prefix": { "type": "string", - "description": "Benchmark prefix." + "description": "Account or benchmark prefix." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for SPAR calculation." }, "SPARBenchmark": { @@ -41649,8 +42377,7 @@ }, "description": "List of SPAR identifiers" } - }, - "additionalProperties": false + } }, "SPARBenchmarkRoot": { "required": [ @@ -41662,8 +42389,7 @@ "$ref": "#/components/schemas/SPARBenchmark" }, "meta": { } - }, - "additionalProperties": false + } }, "ConstraintAction": { "type": "object", @@ -41678,8 +42404,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyAlphaOverride": { "type": "object", @@ -41700,8 +42425,7 @@ "returnMultiplier": { "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyOverrides": { "type": "object", @@ -41724,8 +42448,7 @@ "type": "string", "description": "Transaction cost\r\nCan be set to \"\" for local" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategy": { "required": [ @@ -41740,8 +42463,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "BPMOptimization": { "type": "object", @@ -41766,8 +42488,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "BPMOptimizationParameters": { "required": [ @@ -41788,8 +42509,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "BPMOptimizationParametersRoot": { "type": "object", @@ -41800,8 +42520,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "ColumnSummary": { "type": "object", @@ -41819,7 +42538,6 @@ "description": "Column Category" } }, - "additionalProperties": false, "description": "Column settings (name, directory, category)" }, "ColumnSummaryRoot": { @@ -41835,8 +42553,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "Column": { "type": "object", @@ -41860,8 +42577,7 @@ "type": "string", "description": "Column Category" } - }, - "additionalProperties": false + } }, "ColumnRoot": { "required": [ @@ -41873,8 +42589,7 @@ "$ref": "#/components/schemas/Column" }, "meta": { } - }, - "additionalProperties": false + } }, "ColumnStatistic": { "type": "object", @@ -41883,8 +42598,7 @@ "type": "string", "description": "Column Statistic Name" } - }, - "additionalProperties": false + } }, "ColumnStatisticRoot": { "required": [ @@ -41899,8 +42613,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "ComponentSummary": { "type": "object", @@ -41913,8 +42626,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "ComponentSummaryRoot": { "required": [ @@ -41929,8 +42641,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "PAIdentifier": { "required": [ @@ -41944,10 +42655,9 @@ }, "holdingsmode": { "type": "string", - "description": "Holdings Mode can be B&H, TBR, OMS or EXT." + "description": "Holdings Mode can be B&H, TBR, OMS , EXT or VLT." } - }, - "additionalProperties": false + } }, "PADateParameters": { "required": [ @@ -41969,7 +42679,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for PA calculation." }, "PAComponent": { @@ -42015,8 +42724,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "PAComponentRoot": { "required": [ @@ -42028,8 +42736,50 @@ "$ref": "#/components/schemas/PAComponent" }, "meta": { } - }, - "additionalProperties": false + } + }, + "SPARComponent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Component identifier." + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SPARIdentifier" + }, + "description": "List of accounts in SPAR document." + }, + "benchmarks": { + "$ref": "#/components/schemas/SPARIdentifier" + }, + "currencyIsoCode": { + "type": "string", + "description": "CurrencyCode in SPAR document." + }, + "path": { + "type": "string", + "description": "The path to the document" + }, + "name": { + "type": "string", + "description": "Component name." + }, + "category": { + "type": "string", + "description": "Component category." + } + } + }, + "SPARComponentRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SPARComponent" + } + } }, "VaultIdentifier": { "required": [ @@ -42042,7 +42792,6 @@ "description": "User's FactSet account path OR benchmark." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for Vault calculation." }, "VaultDateParameters": { @@ -42065,7 +42814,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for Vault calculation" }, "VaultComponent": { @@ -42104,8 +42852,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "VaultComponentRoot": { "required": [ @@ -42117,8 +42864,7 @@ "$ref": "#/components/schemas/VaultComponent" }, "meta": { } - }, - "additionalProperties": false + } }, "VaultConfigurationSummary": { "type": "object", @@ -42127,8 +42873,7 @@ "type": "string", "description": "Configuration name." } - }, - "additionalProperties": false + } }, "VaultConfigurationSummaryRoot": { "required": [ @@ -42143,8 +42888,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "ConfigurationAccount": { "type": "object", @@ -42173,8 +42917,7 @@ "type": "string", "description": "Account name." } - }, - "additionalProperties": false + } }, "VaultConfiguration": { "type": "object", @@ -42189,8 +42932,7 @@ "$ref": "#/components/schemas/ConfigurationAccount" } } - }, - "additionalProperties": false + } }, "VaultConfigurationRoot": { "required": [ @@ -42202,8 +42944,7 @@ "$ref": "#/components/schemas/VaultConfiguration" }, "meta": { } - }, - "additionalProperties": false + } }, "Currency": { "type": "object", @@ -42212,8 +42953,7 @@ "type": "string", "description": "Name of currency." } - }, - "additionalProperties": false + } }, "CurrencyRoot": { "required": [ @@ -42228,8 +42968,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "DateParametersSummary": { "type": "object", @@ -42242,8 +42981,7 @@ "type": "string", "description": "End date in YYYYMMDD format." } - }, - "additionalProperties": false + } }, "DateParametersSummaryRoot": { "required": [ @@ -42255,8 +42993,7 @@ "$ref": "#/components/schemas/DateParametersSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfo": { "type": "object", @@ -42270,8 +43007,7 @@ "currency": { "type": "string" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfoRoot": { "required": [ @@ -42286,8 +43022,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "DocumentDirectories": { "type": "object", @@ -42306,8 +43041,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "DocumentDirectoriesRoot": { "required": [ @@ -42319,8 +43053,7 @@ "$ref": "#/components/schemas/DocumentDirectories" }, "meta": { } - }, - "additionalProperties": false + } }, "FIABIdentifier": { "required": [ @@ -42332,8 +43065,7 @@ "type": "string", "description": "User's FactSet account path." } - }, - "additionalProperties": false + } }, "FIABDateParameters": { "required": [ @@ -42351,7 +43083,6 @@ "description": "Calculation's end date." } }, - "additionalProperties": false, "description": "The date parameters for FIAB calculations." }, "FIABCalculationParameters": { @@ -42379,8 +43110,7 @@ "type": "string", "description": "FISettingsDocument (optional) - The given @FIS document will be used to\r\nconfigure analytics assumptions and settings. Expects a GUI-style path (Client:/foo/bar)" } - }, - "additionalProperties": false + } }, "FIABCalculationStatusSummary": { "type": "object", @@ -42395,8 +43125,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "EventSummary": { "type": "object", @@ -42414,8 +43143,7 @@ "type": "string", "description": "Event's type" } - }, - "additionalProperties": false + } }, "FIABCalculationStatus": { "type": "object", @@ -42458,8 +43186,7 @@ }, "description": "List of batch events" } - }, - "additionalProperties": false + } }, "FIReferencePrepay": { "type": "object", @@ -42468,8 +43195,7 @@ "type": "string", "description": "Reference Prepay Name" } - }, - "additionalProperties": false + } }, "FIReferenceSecurity": { "type": "object", @@ -42498,8 +43224,7 @@ "type": "string", "description": "Reference Settlement Date" } - }, - "additionalProperties": false + } }, "FIBankLoans": { "type": "object", @@ -42508,8 +43233,7 @@ "type": "boolean", "description": "Ignore Sinking Fund" } - }, - "additionalProperties": false + } }, "FIMunicipalBonds": { "type": "object", @@ -42522,8 +43246,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FILoss": { "type": "object", @@ -42532,8 +43255,7 @@ "type": "string", "description": "Loss Name" } - }, - "additionalProperties": false + } }, "FIPrepay": { "type": "object", @@ -42542,8 +43264,7 @@ "type": "string", "description": "Prepay Name" } - }, - "additionalProperties": false + } }, "FIServicerAdvancesForSecurities": { "type": "object", @@ -42569,8 +43290,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIPrepayLockout": { "type": "object", @@ -42593,8 +43313,7 @@ "type": "string", "description": "Ym Above" } - }, - "additionalProperties": false + } }, "FICashflows": { "type": "object", @@ -42621,8 +43340,7 @@ "description": "RecoveryLag", "format": "int32" } - }, - "additionalProperties": false + } }, "FIBalloonExtension": { "type": "object", @@ -42655,8 +43373,7 @@ "description": "Coupon Stepup", "format": "double" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForSecurities": { "type": "object", @@ -42685,8 +43402,42 @@ "balloonExtension": { "$ref": "#/components/schemas/FIBalloonExtension" } - }, - "additionalProperties": false + } + }, + "FIAttributionForSecurities": { + "type": "object", + "properties": { + "startPrice": { + "type": "number", + "description": "Start Price", + "format": "double" + }, + "endPrice": { + "type": "number", + "description": "End Price", + "format": "double" + }, + "startSpread": { + "type": "number", + "description": "Start Spread", + "format": "double" + }, + "endSpread": { + "type": "number", + "description": "End Spread", + "format": "double" + }, + "pricingMethod": { + "enum": [ + "Inputted Price", + "Pricing Matrix", + "Actual Spread", + "OAS" + ], + "type": "string", + "description": "Pricing Method" + } + } }, "FISecurity": { "required": [ @@ -42737,6 +43488,9 @@ "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForSecurities" }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForSecurities" + }, "calcFromMethod": { "type": "string", "description": "Calculation Method.\r\nMethods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" @@ -42769,8 +43523,7 @@ "type": "string", "description": "Discount curve" } - }, - "additionalProperties": false + } }, "FIMunicipalBondsForJobSettings": { "type": "object", @@ -42787,8 +43540,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FIMarketEnvironment": { "type": "object", @@ -42803,8 +43555,7 @@ "description": "Rate Path", "default": "FLAT & FORWARD" } - }, - "additionalProperties": false + } }, "FIServicerAdvances": { "type": "object", @@ -42820,8 +43571,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForJobSettings": { "type": "object", @@ -42850,8 +43600,20 @@ "balloonExtension": { "$ref": "#/components/schemas/FIBalloonExtension" } - }, - "additionalProperties": false + } + }, + "FIAttributionForJobSettings": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "description": "Start Date" + }, + "endDate": { + "type": "string", + "description": "End Date" + } + } }, "FIJobSettings": { "required": [ @@ -42900,9 +43662,11 @@ }, "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" + }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForJobSettings" } - }, - "additionalProperties": false + } }, "FICalculationParameters": { "required": [ @@ -42929,8 +43693,7 @@ "jobSettings": { "$ref": "#/components/schemas/FIJobSettings" } - }, - "additionalProperties": false + } }, "CalculationMeta": { "type": "object", @@ -42980,8 +43743,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "FICalculationParametersRoot": { "type": "object", @@ -42992,8 +43754,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PaDoc": { "required": [ @@ -43005,8 +43766,7 @@ "type": "string", "description": "PA document path" } - }, - "additionalProperties": false + } }, "FPOAccount": { "required": [ @@ -43024,8 +43784,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "FPOObjective": { "type": "object", @@ -43043,8 +43802,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategyOverrides": { "type": "object", @@ -43071,8 +43829,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategy": { "required": [ @@ -43087,8 +43844,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "FPOOptimizationParameters": { "required": [ @@ -43109,8 +43865,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "FPOOptimizationParametersRoot": { "type": "object", @@ -43121,8 +43876,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "Frequency": { "type": "object", @@ -43131,8 +43885,7 @@ "type": "string", "description": "Frequency name." } - }, - "additionalProperties": false + } }, "FrequencyRoot": { "required": [ @@ -43147,8 +43900,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "Group": { "type": "object", @@ -43165,8 +43917,7 @@ "type": "string", "description": "Group Category" } - }, - "additionalProperties": false + } }, "GroupRoot": { "required": [ @@ -43181,8 +43932,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "TemplateContentTypes": { "type": "object", @@ -43208,8 +43958,7 @@ }, "description": "Template locked fields" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParameters": { "required": [ @@ -43233,8 +43982,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParametersRoot": { "required": [ @@ -43246,8 +43994,7 @@ "$ref": "#/components/schemas/LinkedPATemplateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummary": { "type": "object", @@ -43268,8 +44015,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummaryRoot": { "required": [ @@ -43281,8 +44027,7 @@ "$ref": "#/components/schemas/LinkedPATemplatePostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummary": { "type": "object", @@ -43299,8 +44044,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummaryRoot": { "required": [ @@ -43315,8 +44059,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParameters": { "type": "object", @@ -43332,8 +44075,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParametersRoot": { "required": [ @@ -43345,8 +44087,7 @@ "$ref": "#/components/schemas/LinkedPATemplateUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplate": { "type": "object", @@ -43378,8 +44119,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateRoot": { "required": [ @@ -43391,8 +44131,7 @@ "$ref": "#/components/schemas/LinkedPATemplate" }, "meta": { } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategyOverrides": { "type": "object", @@ -43421,8 +44160,7 @@ "type": "string", "description": "Alpha" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategy": { "required": [ @@ -43437,8 +44175,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "NPOOptimizationParameters": { "required": [ @@ -43459,8 +44196,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "NPOOptimizationParametersRoot": { "type": "object", @@ -43471,8 +44207,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "PACalculationGroup": { "type": "object", @@ -43485,8 +44220,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "PACalculationColumn": { "type": "object", @@ -43502,8 +44236,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "PACalculationPricingSource": { "type": "object", @@ -43512,8 +44245,7 @@ "type": "string", "description": "Pricing source identifier" } - }, - "additionalProperties": false + } }, "PACalculationDataSources": { "type": "object", @@ -43536,8 +44268,7 @@ "type": "boolean", "description": "Use portfolio pricing sources for benchmark" } - }, - "additionalProperties": false + } }, "PACalculationParameters": { "required": [ @@ -43589,10 +44320,9 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." + "description": "Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "PACalculationParametersRoot": { "type": "object", @@ -43607,8 +44337,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationUnitStatus": { "type": "object", @@ -43643,9 +44372,15 @@ "type": "integer", "description": "The points for the calculation unit.", "format": "int32" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The warnings in a calculation unit." } - }, - "additionalProperties": false + } }, "CalculationStatus": { "type": "object", @@ -43671,8 +44406,7 @@ }, "description": "Number of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationUnitStatusMeta": { "type": "object", @@ -43681,8 +44415,7 @@ "type": "string", "description": "The Info URL of the calculation." } - }, - "additionalProperties": false + } }, "CalculationStatusMeta": { "type": "object", @@ -43694,8 +44427,7 @@ }, "description": "Meta of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationStatusRoot": { "required": [ @@ -43709,8 +44441,7 @@ "meta": { "$ref": "#/components/schemas/CalculationStatusMeta" } - }, - "additionalProperties": false + } }, "CalculationsSummary": { "type": "object", @@ -43740,8 +44471,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "PaginationInfo": { "type": "object", @@ -43768,8 +44498,7 @@ "previousPage": { "type": "string" } - }, - "additionalProperties": false + } }, "PaginationMeta": { "type": "object", @@ -43777,8 +44506,7 @@ "pagination": { "$ref": "#/components/schemas/PaginationInfo" } - }, - "additionalProperties": false + } }, "CalculationsSummaryRoot": { "required": [ @@ -43787,13 +44515,15 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CalculationsSummary" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CalculationsSummary" + } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } - }, - "additionalProperties": false + } }, "PAPricingSource": { "type": "object", @@ -43810,8 +44540,7 @@ "type": "string", "description": "Pricing source category" } - }, - "additionalProperties": false + } }, "PAPricingSourceRoot": { "required": [ @@ -43826,8 +44555,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "PubIdentifier": { "required": [ @@ -43843,8 +44571,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PubDateParameters": { "required": [ @@ -43861,7 +44588,6 @@ "description": "Calculation's end date or as of date." } }, - "additionalProperties": false, "description": "The date parameters for Publisher calculation." }, "PubCalculationParameters": { @@ -43882,12 +44608,10 @@ "dates": { "$ref": "#/components/schemas/PubDateParameters" } - }, - "additionalProperties": false + } }, "PubCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "PubCalculationParametersRoot": { "type": "object", @@ -43902,8 +44626,7 @@ "meta": { "$ref": "#/components/schemas/PubCalculationMeta" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverse": { "required": [ @@ -43930,8 +44653,7 @@ "securityExpr": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverse": { "required": [ @@ -43958,8 +44680,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantUniverse": { "required": [ @@ -43975,8 +44696,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverse": { "required": [ @@ -43992,8 +44712,7 @@ "screen": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantDateList": { "type": "object", @@ -44009,8 +44728,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantDate": { "required": [ @@ -44036,8 +44754,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantFdsDate": { "required": [ @@ -44057,8 +44774,7 @@ "endDate": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpression": { "required": [ @@ -44084,8 +44800,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameter": { "required": [ @@ -44105,8 +44820,7 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParameters": { "type": "object", @@ -44114,8 +44828,7 @@ { "$ref": "#/components/schemas/QuantFormula" } - ], - "additionalProperties": false + ] }, "QuantFormula": { "required": [ @@ -44132,8 +44845,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpression": { "required": [ @@ -44156,203 +44868,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionUniverseObsolete": { - "required": [ - "universeExpr", - "universeType" - ], - "type": "object", - "properties": { - "universeExpr": { - "type": "string" - }, - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "securityExpr": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantUniversalScreenUniverseObsolete": { - "required": [ - "screen" - ], - "type": "object", - "properties": { - "screen": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantIdentifierUniverseObsolete": { - "required": [ - "identifiers", - "universeType" - ], - "type": "object", - "properties": { - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "identifiers": { - "type": "array", - "items": { - "type": "string" - } - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantFdsDateObsolete": { - "required": [ - "calendar", - "endDate", - "frequency", - "startDate" - ], - "type": "object", - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantDateListObsolete": { - "required": [ - "calendar", - "frequency" - ], - "type": "object", - "properties": { - "dates": { - "type": "array", - "items": { - "type": "string" - } - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantFqlExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - }, - "isArrayReturnType": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantUniversalScreenParameterObsolete": { - "required": [ - "name", - "referenceName" - ], - "type": "object", - "properties": { - "referenceName": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantAllUniversalScreenParametersObsolete": { - "type": "object", - "additionalProperties": false + } }, "QuantCalculationParameters": { "type": "object", @@ -44426,8 +44942,7 @@ "jobDescription": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantCalculationMeta": { "type": "object", @@ -44480,8 +44995,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "QuantCalculationParametersRoot": { "type": "object", @@ -44496,8 +45010,7 @@ "meta": { "$ref": "#/components/schemas/QuantCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARDateParameters": { "required": [ @@ -44520,7 +45033,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for SPAR calculation." }, "SPARCalculationParameters": { @@ -44550,8 +45062,7 @@ "type": "string", "description": "Currency ISO code for calculation." } - }, - "additionalProperties": false + } }, "SPARCalculationParametersRoot": { "type": "object", @@ -44566,8 +45077,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PAComponentData": { "type": "object", @@ -44612,10 +45122,9 @@ }, "componentdetail": { "type": "string", - "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." } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParameters": { "required": [ @@ -44639,8 +45148,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParametersRoot": { "required": [ @@ -44652,8 +45160,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummary": { "type": "object", @@ -44673,8 +45180,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummaryRoot": { "required": [ @@ -44686,8 +45192,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentPostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummary": { "type": "object", @@ -44704,8 +45209,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummaryRoot": { "required": [ @@ -44720,8 +45224,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParameters": { "type": "object", @@ -44737,8 +45240,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParametersRoot": { "required": [ @@ -44750,8 +45252,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponent": { "type": "object", @@ -44780,8 +45281,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentRoot": { "required": [ @@ -44793,8 +45293,7 @@ "$ref": "#/components/schemas/TemplatedPAComponent" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParameters": { "required": [ @@ -44855,13 +45354,12 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParametersRoot": { "required": [ @@ -44873,8 +45371,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummary": { "type": "object", @@ -44895,8 +45392,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummaryRoot": { "required": [ @@ -44908,8 +45404,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplatePostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummary": { "type": "object", @@ -44926,8 +45421,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummaryRoot": { "required": [ @@ -44942,8 +45436,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParameters": { "type": "object", @@ -44992,13 +45485,12 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParametersRoot": { "required": [ @@ -45010,8 +45502,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplate": { "type": "object", @@ -45072,7 +45563,7 @@ }, "componentdetail": { "type": "string", - "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." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" @@ -45089,8 +45580,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateRoot": { "required": [ @@ -45102,8 +45592,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplate" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndType": { "type": "object", @@ -45116,8 +45605,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeRoot": { "required": [ @@ -45132,8 +45620,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateColumnDetails": { "type": "object", @@ -45153,8 +45640,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateGroupDetails": { "type": "object", @@ -45171,8 +45657,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetails": { "type": "object", @@ -45207,8 +45692,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { "required": [ @@ -45220,8 +45704,36 @@ "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails" }, "meta": { } - }, - "additionalProperties": false + } + }, + "VaultAttributionLoaderResponse": { + "type": "object", + "properties": { + "processId": { + "type": "string", + "description": "ProcessId." + }, + "groupId": { + "type": "string", + "description": "GroupId." + }, + "objectId": { + "type": "string", + "description": "ObjectId." + } + } + }, + "VaultAttributionLoaderResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/VaultAttributionLoaderResponse" + }, + "meta": { } + } }, "VaultCalculationParameters": { "required": [ @@ -45247,10 +45759,9 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." + "description": "Component detail type for the Vault component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "VaultCalculationParametersRoot": { "type": "object", @@ -45265,8 +45776,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } } }, "securitySchemes": {