diff --git a/openapi-schema-oneof-referenced-schema.json b/openapi-schema-oneof-referenced-schema.json index c1eccd7..5f3b0e6 100644 --- a/openapi-schema-oneof-referenced-schema.json +++ b/openapi-schema-oneof-referenced-schema.json @@ -8750,29 +8750,29 @@ ] } }, - "/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" } } ], "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 +8810,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 +8860,7 @@ } }, "404": { - "description": "Vault Document not found.", + "description": "Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9064,34 +9064,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 +9129,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 +9179,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 +9383,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 +9448,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 +9498,7 @@ } }, "404": { - "description": "Account not found.", + "description": "Vault Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -9702,34 +9702,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 +9767,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 +9817,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 +10021,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 +10086,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 +10340,22 @@ "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.", @@ -10334,95 +10393,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DateParametersSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid query parameter or value is 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" - } - } - } - }, - "404": { - "description": "Document or account 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" + "$ref": "#/components/schemas/CurrencyRoot" } } } @@ -10588,19 +10559,19 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "DateParametersSummaryRoot" + "response-type": "CurrencyRoot" } ] } }, - "/analytics/engines/vault/v3/dates": { + "/analytics/engines/pa/v3/dates": { "get": { "tags": [ "Dates" ], - "summary": "Convert Vault dates to absolute format", - "description": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal.", - "operationId": "convertVaultDatesToAbsoluteFormat", + "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", @@ -10624,11 +10595,11 @@ { "name": "componentid", "in": "query", - "description": "Vault Component Id", + "description": "Component Id", "required": true, "schema": { "type": "string", - "description": "Vault Component Id" + "description": "Component Id" } }, { @@ -10732,7 +10703,7 @@ } }, "404": { - "description": "vault Document or account not found.", + "description": "Document or account not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -10941,302 +10912,58 @@ ] } }, - "/analytics/engines/fi/v3/discount-curves": { + "/analytics/engines/vault/v3/dates": { "get": { "tags": [ - "DiscountCurves" + "Dates" ], - "summary": "Get Discount Curves", - "description": "This endpoint lists all the discount curves that can be applied to a FI calculation.", - "operationId": "getAllFIDiscountCurves", + "summary": "Convert Vault dates to absolute format", + "description": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal.", + "operationId": "convertVaultDatesToAbsoluteFormat", "parameters": [ { - "name": "currency", + "name": "startdate", "in": "query", + "description": "Start Date", "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of FI discount curves.", - "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/FIDiscountCurveInfoRoot" - } - } + "type": "string", + "description": "Start Date" } }, - "404": { - "description": "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" - } - } + { + "name": "enddate", + "in": "query", + "description": "End Date", + "required": true, + "schema": { + "type": "string", + "description": "End Date" } }, - "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." - } - } + { + "name": "componentid", + "in": "query", + "description": "Vault Component Id", + "required": true, + "schema": { + "type": "string", + "description": "Vault Component Id" } }, - "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": "FIDiscountCurveInfoRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/documents/{path}": { - "get": { - "tags": [ - "Documents" - ], - "summary": "Get PA3 documents and sub-directories in a directory", - "description": "This endpoint looks up all PA3 documents and sub-directories in a given directory.", - "operationId": "getPA3Documents", - "parameters": [ - { - "name": "path", - "in": "path", - "description": "The directory to get the documents and sub-directories in", - "required": true, - "schema": { - "type": "string", - "description": "The directory to get the documents and sub-directories in", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of PA3 documents and directories", + { + "name": "account", + "in": "query", + "description": "Account", + "required": true, + "schema": { + "type": "string", + "description": "Account" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the converted dates in yyyymmdd format.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11274,13 +11001,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "$ref": "#/components/schemas/DateParametersSummaryRoot" } } } }, "400": { - "description": "Invalid query parameter or value provided", + "description": "Invalid query parameter or value is provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11324,7 +11051,7 @@ } }, "404": { - "description": "Path not found", + "description": "vault Document or account not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11368,7 +11095,7 @@ } }, "401": { - "description": "Missing or invalid authentication", + "description": "Missing or invalid authentication.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11424,7 +11151,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.", @@ -11486,7 +11213,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.", @@ -11505,7 +11232,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.", @@ -11528,79 +11255,31 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "DocumentDirectoriesRoot" + "response-type": "DateParametersSummaryRoot" } ] } }, - "/analytics/engines/vault/v3/documents/{path}": { + "/analytics/engines/fi/v3/discount-curves": { "get": { "tags": [ - "Documents" + "DiscountCurves" ], - "summary": "Get Vault documents and sub-directories in a directory", - "description": "This endpoint looks up all Vault documents and sub-directories in a given directory.", - "operationId": "getVaultDocuments", + "summary": "Get Discount Curves", + "description": "This endpoint lists all the discount curves that can be applied to a FI calculation.", + "operationId": "getAllFIDiscountCurves", "parameters": [ { - "name": "path", - "in": "path", - "description": "The directory to get the documents in", - "required": true, + "name": "currency", + "in": "query", "schema": { - "type": "string", - "description": "The directory to get the documents in", - "default": "" + "type": "string" } } ], "responses": { "200": { - "description": "Expected response, returns a list of Vault documents and directories", - "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/DocumentDirectoriesRoot" - } - } - } - }, - "400": { - "description": "Invalid query parameter or value provided", + "description": "Expected response, returns a list of FI discount curves.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11638,13 +11317,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/FIDiscountCurveInfoRoot" } } } }, "404": { - "description": "Path not found", + "description": "Not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11688,7 +11367,7 @@ } }, "401": { - "description": "Missing or invalid authentication", + "description": "Missing or invalid authentication.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -11744,7 +11423,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.", @@ -11806,7 +11485,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.", @@ -11825,7 +11504,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.", @@ -11848,35 +11527,35 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "DocumentDirectoriesRoot" + "response-type": "FIDiscountCurveInfoRoot" } ] } }, - "/analytics/engines/spar/v3/documents/{path}": { + "/analytics/engines/pa/v3/documents/{path}": { "get": { "tags": [ "Documents" ], - "summary": "Gets SPAR3 documents and sub-directories in a directory", - "description": "This endpoint looks up all SPAR3 documents and sub-directories in a given directory.", - "operationId": "getSPAR3Documents", + "summary": "Get PA3 documents and sub-directories in a directory", + "description": "This endpoint looks up all PA3 documents and sub-directories in a given directory.", + "operationId": "getPA3Documents", "parameters": [ { "name": "path", "in": "path", - "description": "The directory to get the documents in", + "description": "The directory to get the documents and sub-directories in", "required": true, "schema": { "type": "string", - "description": "The directory to get the documents in", + "description": "The directory to get the documents and sub-directories in", "default": "" } } ], "responses": { "200": { - "description": "Expected response, returns a list of SPAR3 documents and directories", + "description": "Expected response, returns a list of PA3 documents and directories", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -12173,14 +11852,14 @@ ] } }, - "/analytics/engines/pub/v3/documents/{path}": { + "/analytics/engines/vault/v3/documents/{path}": { "get": { "tags": [ "Documents" ], - "summary": "Gets Publisher documents and sub-directories in a directory", - "description": "This endpoint looks up all Publisher documents and sub-directories in a given directory.", - "operationId": "getPubDocuments", + "summary": "Get Vault documents and sub-directories in a directory", + "description": "This endpoint looks up all Vault documents and sub-directories in a given directory.", + "operationId": "getVaultDocuments", "parameters": [ { "name": "path", @@ -12196,7 +11875,7 @@ ], "responses": { "200": { - "description": "Expected response, returns a list of Publisher documents and directories", + "description": "Expected response, returns a list of Vault documents and directories", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -12493,93 +12172,31 @@ ] } }, - "/analytics/engines/fiab/v1/calculations": { - "post": { + "/analytics/engines/spar/v3/documents/{path}": { + "get": { "tags": [ - "FIAB Calculations" + "Documents" ], - "summary": "Run FIAB calculation", - "description": "This endpoint creates a new FIAB calculation.\r\nThis must be used first before get status or cancelling endpoints with a calculation id.\r\nA successful response will contain the URL to check the status of the calculation request.\r\n\r\nRemarks:\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the FIAB template.", - "operationId": "runCalculation", - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIABCalculationParameters" - } + "summary": "Gets SPAR3 documents and sub-directories in a directory", + "description": "This endpoint looks up all SPAR3 documents and sub-directories in a given directory.", + "operationId": "getSPAR3Documents", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "The directory to get the documents in", + "required": true, + "schema": { + "type": "string", + "description": "The directory to get the documents in", + "default": "" } } - }, + ], "responses": { - "202": { - "description": "Expected response, contains the URL in the Location header to check the status of the calculation.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - }, - "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" - } - } - } - }, - "400": { - "description": "Invalid POST body.", + "200": { + "description": "Expected response, returns a list of SPAR3 documents and directories", "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -12594,20 +12211,6 @@ "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - }, "X-FactSet-Api-RateLimit-Limit": { "description": "Number of allowed requests for the time window.", "schema": { @@ -12626,116 +12229,18 @@ "type": "string" } } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - }, - "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.", + }, + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/DocumentDirectoriesRoot" } } } }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "400": { + "description": "Invalid query parameter or value provided", "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -12750,20 +12255,6 @@ "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - }, "X-FactSet-Api-RateLimit-Limit": { "description": "Number of allowed requests for the time window.", "schema": { @@ -12782,171 +12273,17 @@ "type": "string" } } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel FIAB Calculation endpoint or wait for older requests to finish / expire.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - }, - "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": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", + }, + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." - } - }, - "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-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." - } - }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FIAB requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FIAB requests remaining till request limit reached." - } - } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": null - } - ] - }, - "get": { - "tags": [ - "FIAB Calculations" - ], - "summary": "Get all FIAB calculation summaries", - "description": "This endpoints returns all FIAB calculation requests.", - "operationId": "getCalculationStatusSummaries", - "responses": { - "200": { - "description": "List of active FIAB calculation requests.", + "404": { + "description": "Path not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -12984,16 +12321,13 @@ "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/FIABCalculationStatusSummary" - } + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, "401": { - "description": "Missing or invalid authentication.", + "description": "Missing or invalid authentication", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -13012,7 +12346,7 @@ } }, "403": { - "description": "User is forbidden with current credentials.", + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -13049,7 +12383,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.", @@ -13111,7 +12445,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.", @@ -13130,7 +12464,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.", @@ -13153,56 +12487,36 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": null + "response-type": "DocumentDirectoriesRoot" } ] } }, - "/analytics/engines/fiab/v1/calculations/{id}": { + "/analytics/engines/pub/v3/documents/{path}": { "get": { "tags": [ - "FIAB Calculations" + "Documents" ], - "summary": "Get FIAB calculation by id", - "description": "This is the endpoint to check on the progress of a previously requested calculation.", - "operationId": "getCalculationById", + "summary": "Gets Publisher documents and sub-directories in a directory", + "description": "This endpoint looks up all Publisher documents and sub-directories in a given directory.", + "operationId": "getPubDocuments", "parameters": [ { - "name": "id", + "name": "path", "in": "path", - "description": "from url, provided from the location header in the Run FIAB Calculation endpoint", + "description": "The directory to get the documents in", "required": true, "schema": { "type": "string", - "description": "from url, provided from the location header in the Run FIAB Calculation endpoint" + "description": "The directory to get the documents in", + "default": "" } } ], "responses": { "200": { - "description": "Expected response, returns status information of the entire calculation if it is complete.", + "description": "Expected response, returns a list of Publisher 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": { @@ -13239,21 +12553,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FIABCalculationStatus" + "$ref": "#/components/schemas/DocumentDirectoriesRoot" } } } }, - "202": { - "description": "Expected response, returns status information of the entire calculation if it is not complete.", + "400": { + "description": "Invalid query parameter or value provided", "headers": { - "Cache-Control": { - "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.", - "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": { @@ -13290,13 +12597,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FIABCalculationStatus" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "400": { - "description": "Invalid identifier provided.", + "404": { + "description": "Path not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -13330,10 +12637,17 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "401": { - "description": "Missing or invalid authentication.", + "description": "Missing or invalid authentication", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -13388,8 +12702,8 @@ } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -13425,6 +12739,31 @@ } } }, + "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": { @@ -13445,7 +12784,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.", @@ -13468,60 +12807,38 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "FIABCalculationStatus" - }, - { - "status-code": "202", - "response-type": "FIABCalculationStatus" + "response-type": "DocumentDirectoriesRoot" } ] } }, - "/analytics/engines/fi/v3/calculations": { + "/analytics/engines/fiab/v1/calculations": { "post": { "tags": [ - "FICalculations" - ], - "summary": "Create and Run FI calculation", - "description": "This endpoint creates and runs a new FI calculation specified in the post body.", - "operationId": "postAndCalculate", - "parameters": [ - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds.", - "schema": { - "type": "integer" - } - }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts max-stale.", - "schema": { - "type": "string" - } - } + "FIAB Calculations" ], + "summary": "Run FIAB calculation", + "description": "This endpoint creates a new FIAB calculation.\r\nThis must be used first before get status or cancelling endpoints with a calculation id.\r\nA successful response will contain the URL to check the status of the calculation request.\r\n\r\nRemarks:\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the FIAB template.", + "operationId": "runCalculation", "requestBody": { - "description": "Calculation Parameters", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FICalculationParametersRoot" + "$ref": "#/components/schemas/FIABCalculationParameters" } } } }, "responses": { "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "description": "Expected response, contains the URL in the Location header to check the status of the calculation.", "headers": { "Location": { - "description": "URL to poll for the resulting calculation", + "description": "URL to check status of the request.", "schema": { "type": "string", - "description": "URL to poll for the resulting calculation" + "description": "URL to check status of the request." } }, "X-DataDirect-Request-Key": { @@ -13539,17 +12856,17 @@ } }, "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", + "description": "Maximum FIAB request limit.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "Maximum FIAB request limit." } }, "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", + "description": "Number of FIAB requests remaining till request limit reached.", "schema": { "type": "string", - "description": "Number of FI requests remaining till request limit reached." + "description": "Number of FIAB requests remaining till request limit reached." } }, "X-FactSet-Api-RateLimit-Limit": { @@ -13570,23 +12887,18 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" - } - } } }, - "201": { - "description": "Expected response if calculation is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "400": { + "description": "Invalid POST body.", "headers": { + "Location": { + "description": "URL to check status of the request.", + "schema": { + "type": "string", + "description": "URL to check status of the request." + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -13602,17 +12914,17 @@ } }, "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", + "description": "Maximum FIAB request limit.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "Maximum FIAB request limit." } }, "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", + "description": "Number of FIAB requests remaining till request limit reached.", "schema": { "type": "string", - "description": "Number of FI requests remaining till request limit reached." + "description": "Number of FIAB requests remaining till request limit reached." } }, "X-FactSet-Api-RateLimit-Limit": { @@ -13633,23 +12945,58 @@ "type": "string" } } - }, - "content": { - "application/json": { + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "Location": { + "description": "URL to check status of the request.", "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "type": "string", + "description": "URL to check status of the request." } }, - "application/x-protobuf": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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-Calculations-Limit": { + "description": "Maximum FIAB request limit.", + "schema": { + "type": "string", + "description": "Maximum FIAB request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FIAB requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FIAB requests remaining till request limit reached." } } } }, - "400": { - "description": "Invalid calculation parameters.", + "403": { + "description": "User is forbidden with current credentials.", "headers": { + "Location": { + "description": "URL to check status of the request.", + "schema": { + "type": "string", + "description": "URL to check status of the request." + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -13665,17 +13012,17 @@ } }, "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", + "description": "Maximum FIAB request limit.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "Maximum FIAB request limit." } }, "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", + "description": "Number of FIAB requests remaining till request limit reached.", "schema": { "type": "string", - "description": "Number of FI requests remaining till request limit reached." + "description": "Number of FIAB requests remaining till request limit reached." } }, "X-FactSet-Api-RateLimit-Limit": { @@ -13696,23 +13043,18 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", "headers": { + "Location": { + "description": "URL to check status of the request.", + "schema": { + "type": "string", + "description": "URL to check status of the request." + } + }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -13728,17 +13070,17 @@ } }, "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", + "description": "Maximum FIAB request limit.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "Maximum FIAB request limit." } }, "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", + "description": "Number of FIAB requests remaining till request limit reached.", "schema": { "type": "string", - "description": "Number of FI requests remaining till request limit reached." + "description": "Number of FIAB requests remaining till request limit reached." } }, "X-FactSet-Api-RateLimit-Limit": { @@ -13759,56 +13101,18 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "401": { - "description": "Missing or invalid authentication.", + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel FIAB Calculation endpoint or wait for older requests to finish / expire.", "headers": { - "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-Calculations-Limit": { - "description": "Maximum FI request limit.", + "Location": { + "description": "URL to check status of the request.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "URL to check status of the request." } }, - "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", - "schema": { - "type": "string", - "description": "Number of FI requests remaining till request limit reached." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -13824,17 +13128,17 @@ } }, "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", + "description": "Maximum FIAB request limit.", "schema": { "type": "string", - "description": "Maximum FI request limit." + "description": "Maximum FIAB request limit." } }, "X-FactSet-Api-Calculations-Remaining": { - "description": "Number of FI requests remaining till request limit reached.", + "description": "Number of FIAB requests remaining till request limit reached.", "schema": { "type": "string", - "description": "Number of FI requests remaining till request limit reached." + "description": "Number of FIAB requests remaining till request limit reached." } }, "X-FactSet-Api-RateLimit-Limit": { @@ -13854,7 +13158,1022 @@ "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": { + "Location": { + "description": "URL to check status of the request.", + "schema": { + "type": "string", + "description": "URL to check status of the request." + } + }, + "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-Calculations-Limit": { + "description": "Maximum FIAB request limit.", + "schema": { + "type": "string", + "description": "Maximum FIAB request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FIAB requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FIAB requests remaining till request limit reached." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "Location": { + "description": "URL to check status of the request.", + "schema": { + "type": "string", + "description": "URL to check status of the request." + } + }, + "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-Calculations-Limit": { + "description": "Maximum FIAB request limit.", + "schema": { + "type": "string", + "description": "Maximum FIAB request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FIAB requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FIAB requests remaining till request limit reached." + } + } + } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": null + } + ] + }, + "get": { + "tags": [ + "FIAB Calculations" + ], + "summary": "Get all FIAB calculation summaries", + "description": "This endpoints returns all FIAB calculation requests.", + "operationId": "getCalculationStatusSummaries", + "responses": { + "200": { + "description": "List of active FIAB calculation 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." + } + }, + "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": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/FIABCalculationStatusSummary" + } + } + } + } + }, + "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": null + } + ] + } + }, + "/analytics/engines/fiab/v1/calculations/{id}": { + "get": { + "tags": [ + "FIAB Calculations" + ], + "summary": "Get FIAB calculation by id", + "description": "This is the endpoint to check on the progress of a previously requested calculation.", + "operationId": "getCalculationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Run FIAB Calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Run FIAB Calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns status information of the entire calculation if it is complete.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "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/FIABCalculationStatus" + } + } + } + }, + "202": { + "description": "Expected response, returns status information of the entire calculation if it is not complete.", + "headers": { + "Cache-Control": { + "description": "Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.", + "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" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FIABCalculationStatus" + } + } + } + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "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." + } + }, + "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" + } + } + } + }, + "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": "FIABCalculationStatus" + }, + { + "status-code": "202", + "response-type": "FIABCalculationStatus" + } + ] + } + }, + "/analytics/engines/fi/v3/calculations": { + "post": { + "tags": [ + "FICalculations" + ], + "summary": "Create and Run FI calculation", + "description": "This endpoint creates and runs a new FI calculation specified in the post body.", + "operationId": "postAndCalculate", + "parameters": [ + { + "name": "X-FactSet-Api-Long-Running-Deadline", + "in": "header", + "description": "Long running deadline in seconds.", + "schema": { + "type": "integer" + } + }, + { + "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/FICalculationParametersRoot" + } + } + } + }, + "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": { + "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-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + }, + "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/CalculationInfoRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } + } + } + }, + "201": { + "description": "Expected response if calculation is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + }, + "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/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + } + } + }, + "400": { + "description": "Invalid calculation 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-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + }, + "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": "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-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + }, + "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." + } + }, + "X-FactSet-Api-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + } + } + }, + "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-Calculations-Limit": { + "description": "Maximum FI request limit.", + "schema": { + "type": "string", + "description": "Maximum FI request limit." + } + }, + "X-FactSet-Api-Calculations-Remaining": { + "description": "Number of FI requests remaining till request limit reached.", + "schema": { + "type": "string", + "description": "Number of FI requests remaining till request limit reached." + } + }, + "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": { @@ -22442,7 +22761,7 @@ "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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "postAndCalculate", "parameters": [ { @@ -23240,7 +23559,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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "putAndCalculate", "parameters": [ { @@ -28023,16 +28342,9 @@ } }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "Expected response if the calculation has one unit and is completed with an error.", "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -28071,11 +28383,6 @@ "schema": { "$ref": "#/components/schemas/CalculationStatusRoot" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } } } }, @@ -28116,70 +28423,24 @@ } }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "200": { - "description": "Expected response if the calculation has one unit and is completed with an error.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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/CalculationStatusRoot" - } - }, - "application/x-protobuf": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "type": "string", + "format": "binary" } } } }, - "400": { - "description": "Invalid calculation parameters.", + "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": { @@ -28216,18 +28477,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/CalculationStatusRoot" } } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "400": { + "description": "Invalid calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -28267,11 +28523,6 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -28331,6 +28582,94 @@ } } }, + "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" + } + } + } + }, + "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" + } + } + } + }, "415": { "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", "headers": { @@ -28453,15 +28792,16 @@ "x-are-multiple-success-responses-different": true, "x-success-response-types": [ { - "status-code": "202", + "status-code": "200", "response-type": "CalculationStatusRoot" }, { "status-code": "201", - "response-type": "ObjectRoot" + "response-type": null, + "is-file": true }, { - "status-code": "200", + "status-code": "202", "response-type": "CalculationStatusRoot" } ] @@ -28823,16 +29163,9 @@ } }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "Expected response if the calculation has one unit and is completed with an error.", "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -28871,16 +29204,11 @@ "schema": { "$ref": "#/components/schemas/CalculationStatusRoot" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } } } }, - "200": { - "description": "Expected response if the calculation has one unit and is completed with an error.", + "201": { + "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -28916,21 +29244,24 @@ } }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "type": "string", + "format": "binary" } } } }, - "201": { - "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "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": { @@ -28967,12 +29298,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$ref": "#/components/schemas/CalculationStatusRoot" } } } @@ -29018,16 +29344,30 @@ "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." + } }, - "application/x-protobuf": { + "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." } } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29061,22 +29401,10 @@ "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.", + "404": { + "description": "One or more calculation settings were unavailable.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29116,16 +29444,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, - "401": { - "description": "Missing or invalid authentication.", + "409": { + "description": "Duplicate calculation exists with same parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29140,11 +29463,36 @@ "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" + } } } }, - "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,6 +29526,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "415": { @@ -29301,17 +29656,18 @@ }, "x-are-multiple-success-responses-different": true, "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, { "status-code": "200", "response-type": "CalculationStatusRoot" }, { "status-code": "201", - "response-type": "ObjectRoot" + "response-type": null, + "is-file": true + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" } ] }, @@ -30041,15 +30397,264 @@ } }, "content": { - "application/json": { + "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." + } + }, + "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" + } + } + } + }, + "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": "CalculationStatusRoot" + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + } + ] + } + }, + "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result": { + "get": { + "tags": [ + "QuantCalculations" + ], + "summary": "Get Quant Engine 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 Get Quant Engine calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" + } + }, + { + "name": "unitId", + "in": "path", + "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" + } + } + ], + "responses": { + "200": { + "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.", + "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/octet-stream": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "format": "binary" } } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30148,6 +30753,50 @@ } } }, + "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." + } + }, + "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" + } + } + } + }, "500": { "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", "headers": { @@ -30191,48 +30840,45 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "202", - "response-type": "CalculationStatusRoot" + "response-type": null, + "is-file": true } ] } }, - "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result": { + "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info": { "get": { "tags": [ "QuantCalculations" ], - "summary": "Get Quant Engine 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 Quant Engine calculation metadata information by id", + "description": "This is the endpoint to get the metadata information of a previously requested calculation.", + "operationId": "getCalculationUnitInfoById", "parameters": [ { "name": "id", "in": "path", - "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint", + "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint", "required": true, "schema": { "type": "string", - "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" + "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" } }, { "name": "unitId", "in": "path", - "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint", + "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint", "required": true, "schema": { "type": "string", - "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" + "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" } } ], "responses": { "200": { - "description": "Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters.", + "description": "Expected response once calculation is completed.", "headers": { "Content-Encoding": { "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", @@ -30289,18 +30935,6 @@ } }, "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/octet-stream": { "schema": { "type": "string", @@ -30350,21 +30984,30 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "FactSet's request key header." } }, - "application/octet-stream": { + "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." } } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30398,46 +31041,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/octet-stream": { - "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": "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.", @@ -30471,6 +31078,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "500": { @@ -30522,61 +31136,151 @@ ] } }, - "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info": { - "get": { + "/analytics/engines/spar/v3/calculations": { + "post": { "tags": [ - "QuantCalculations" + "SPARCalculations" ], - "summary": "Get Quant Engine calculation metadata information by id", - "description": "This is the endpoint to get the metadata information of a previously requested calculation.", - "operationId": "getCalculationUnitInfoById", + "summary": "Create and Run SPAR calculation", + "description": "This endpoint runs the SPAR calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the SPAR template.", + "operationId": "postAndCalculate", "parameters": [ { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint", - "required": true, + "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": "string", - "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" + "type": "integer" } }, { - "name": "unitId", - "in": "path", - "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint", - "required": true, + "name": "Cache-Control", + "in": "header", + "description": "Standard HTTP header. Accepts max-stale.", "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" + "type": "string" } } ], + "requestBody": { + "description": "Calculation Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SPARCalculationParametersRoot" + } + } + } + }, "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": { + "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/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } + } + }, "200": { - "description": "Expected response once calculation is completed.", + "description": "Expected response, if the calculation has one unit and is completed with an error.", "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + "description": "FactSet's request key header." } }, - "Content-Type": { - "description": "Standard HTTP header.", + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { "type": "string", - "description": "Standard HTTP header." + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + "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/CalculationStatusRoot" } }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } + } + }, + "201": { + "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -30613,26 +31317,18 @@ "content": { "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/ObjectRoot" } }, "application/x-protobuf": { "schema": { - "type": "string", - "format": "binary" - } - }, - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/ObjectRoot" } } } }, "400": { - "description": "Invalid identifier provided.", + "description": "Invalid calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30677,16 +31373,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "description": "One or more calculation settings were unavailable.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30731,11 +31422,6 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -30795,8 +31481,88 @@ } } }, + "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.", @@ -30834,63 +31600,45 @@ } } }, - "x-are-multiple-success-responses-different": false, + "x-are-multiple-success-responses-different": true, "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, { "status-code": "200", - "response-type": null, - "is-file": true + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } ] - } - }, - "/analytics/engines/spar/v3/calculations": { - "post": { + }, + "get": { "tags": [ "SPARCalculations" ], - "summary": "Create and Run SPAR calculation", - "description": "This endpoint runs the SPAR calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the SPAR template.", - "operationId": "postAndCalculate", + "summary": "Get all calculations", + "description": "This endpoints returns all calculation requests.", + "operationId": "getAllCalculations", "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": "pageNumber", + "in": "query", + "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int32", + "default": 1 } } ], - "requestBody": { - "description": "Calculation Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SPARCalculationParametersRoot" - } - } - } - }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "List of calculation requests.", "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": { @@ -30927,18 +31675,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/CalculationsSummaryRoot" } } } }, - "200": { - "description": "Expected response, if the calculation has one unit and is completed with an error.", + "400": { + "description": "Invalid page number.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30976,18 +31719,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "201": { - "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "404": { + "description": "No calculation found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31025,18 +31763,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$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." } }, - "application/x-protobuf": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } } } }, - "400": { - "description": "Invalid calculation parameters.", + "403": { + "description": "User is forbidden with current credentials.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31070,22 +31822,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31119,22 +31859,35 @@ "type": "string" } } - }, - "content": { - "application/json": { + } + }, + "429": { + "description": "Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" } } } }, - "401": { - "description": "Missing or invalid authentication.", + "500": { + "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31152,8 +31905,8 @@ } } }, - "403": { - "description": "User is forbidden with current credentials", + "503": { + "description": "Request timed out. Retry the request in sometime.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31168,30 +31921,76 @@ "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" - } } } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CalculationsSummaryRoot" + } + ] + } + }, + "/analytics/engines/spar/v3/calculations/{id}": { + "put": { + "tags": [ + "SPARCalculations" + ], + "summary": "Create or Update SPAR calculation and run it.", + "description": "This endpoint updates and run the SPAR calculation specified in the PUT body parameters. This also allows creating new SPAR calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the SPAR template.", + "operationId": "putAndCalculate", + "parameters": [ + { + "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" + } }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + { + "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.", + "schema": { + "type": "integer" + } + }, + { + "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/SPARCalculationParametersRoot" + } + } + } + }, + "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": { @@ -31224,10 +32023,22 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } } }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "200": { + "description": "Expected response, if the calculation has one unit and is completed with an error.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31260,17 +32071,23 @@ "schema": { "type": "string" } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "application/x-protobuf": { "schema": { - "type": "string" + "$ref": "#/components/schemas/CalculationStatusRoot" } } } }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", + "201": { + "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31285,67 +32102,41 @@ "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" + } } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "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/ObjectRoot" } }, - "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/ObjectRoot" } } } - } - }, - "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 all calculations", - "description": "This endpoints returns all calculation requests.", - "operationId": "getAllCalculations", - "parameters": [ - { - "name": "pageNumber", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "List of calculation requests.", + "400": { + "description": "Invalid Calculation Parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31383,13 +32174,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationsSummaryRoot" + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "400": { - "description": "Invalid page number.", + "404": { + "description": "One or more calculation settings were unavailable.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31429,11 +32225,16 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "404": { - "description": "No calculation found.", + "409": { + "description": "Duplicate calculation exists with same parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31473,6 +32274,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -31496,7 +32302,7 @@ } }, "403": { - "description": "User is forbidden with current credentials.", + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31532,8 +32338,8 @@ } } }, - "406": { - "description": "Unsupported Accept header. Header needs to be set to application/json.", + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31570,7 +32376,7 @@ } }, "429": { - "description": "Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.", + "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31586,6 +32392,24 @@ "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": { @@ -31633,23 +32457,29 @@ } } }, - "x-are-multiple-success-responses-different": false, + "x-are-multiple-success-responses-different": true, "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, { "status-code": "200", - "response-type": "CalculationsSummaryRoot" + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } ] - } - }, - "/analytics/engines/spar/v3/calculations/{id}": { - "put": { + }, + "get": { "tags": [ "SPARCalculations" ], - "summary": "Create or Update SPAR calculation and run it.", - "description": "This endpoint updates and run the SPAR calculation specified in the PUT body parameters. This also allows creating new SPAR calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the SPAR template.", - "operationId": "putAndCalculate", + "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", @@ -31660,43 +32490,31 @@ "type": "string", "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" } - }, - { - "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.", - "schema": { - "type": "integer" - } - }, - { - "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/SPARCalculationParametersRoot" - } - } - } - }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "Expected response, returns the SPAR calculation parameters.", "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", "schema": { "type": "string", - "description": "URL to poll for the resulting calculation" + "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": { @@ -31735,18 +32553,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/SPARCalculationParametersRoot" } } } }, - "200": { - "description": "Expected response, if the calculation has one unit and is completed with an error.", + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31784,18 +32597,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "201": { - "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "404": { + "description": "Calculation id not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31833,18 +32641,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$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." } }, - "application/x-protobuf": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } } } }, - "400": { - "description": "Invalid Calculation Parameters.", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31878,22 +32700,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "500": { + "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31908,41 +32718,59 @@ "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": { + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } } } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "SPARCalculationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "SPARCalculations" + ], + "summary": "Cancel SPAR calculation", + "description": "This is the endpoint to cancel a previously submitted calculation.", + "operationId": "cancelCalculationById", + "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": { + "204": { + "description": "Expected response, calculation was canceled successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -31976,41 +32804,10 @@ "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", + "400": { + "description": "Invalid identifier provided.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32044,10 +32841,27 @@ "type": "string" } } + }, + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "404": { + "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.", @@ -32081,10 +32895,46 @@ "type": "string" } } + }, + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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.", @@ -32117,12 +32967,6 @@ "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" - } } } }, @@ -32165,29 +33009,23 @@ } } }, - "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" + "status-code": "204", + "response-type": null } ] - }, + } + }, + "/analytics/engines/spar/v3/calculations/{id}/status": { "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", + "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", @@ -32202,7 +33040,7 @@ ], "responses": { "200": { - "description": "Expected response, returns the SPAR calculation parameters.", + "description": "Expected response once calculation is completed.", "headers": { "Content-Encoding": { "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", @@ -32261,7 +33099,65 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SPARCalculationParametersRoot" + "$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" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" } } } @@ -32311,7 +33207,7 @@ } }, "404": { - "description": "Calculation id not found", + "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32453,33 +33349,70 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "SPARCalculationParametersRoot" + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" } ] - }, - "delete": { + } + }, + "/analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result": { + "get": { "tags": [ "SPARCalculations" ], - "summary": "Cancel SPAR calculation", - "description": "This is the endpoint to cancel a previously submitted calculation.", - "operationId": "cancelCalculationById", + "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": { - "204": { - "description": "Expected response, calculation was canceled successfully.", + "200": { + "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.", + "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,6 +33445,18 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + } } }, "400": { @@ -32551,17 +33496,12 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } }, - "text/json": { + "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } @@ -32569,7 +33509,7 @@ } }, "404": { - "description": "There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier.", + "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32605,17 +33545,12 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } }, - "text/json": { + "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } @@ -32679,7 +33614,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,57 +33655,37 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "ObjectRoot" } ] } }, - "/analytics/engines/spar/v3/calculations/{id}/status": { + "/analytics/engines/axp/v3/strategies/{path}": { "get": { "tags": [ - "SPARCalculations" + "StrategyDocuments" ], - "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 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", + "name": "path", "in": "path", - "description": "from url, provided from the location header in the Create and Run SPAR calculation 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 Create and Run SPAR calculation endpoint" + "description": "The directory to get the strategy documents and sub-directories in", + "default": "" } } ], "responses": { "200": { - "description": "Expected response once calculation is completed.", + "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": { @@ -32807,28 +33722,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/DocumentDirectoriesRoot" } } } }, - "202": { - "description": "Expected response returned if the calculation is not yet completed.", + "400": { + "description": "Invalid query parameter or value provided", "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": { @@ -32865,13 +33766,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "400": { - "description": "Invalid identifier provided.", + "404": { + "description": "Path not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32914,8 +33815,27 @@ } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "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.", @@ -32949,17 +33869,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "401": { - "description": "Missing or invalid authentication.", + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32974,11 +33887,29 @@ "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" + } } } }, - "403": { - "description": "User is forbidden with current credentials", + "429": { + "description": "Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -32994,20 +33925,8 @@ "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.", + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", "schema": { "type": "string" } @@ -33034,7 +33953,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.", @@ -33057,118 +33976,35 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "202", - "response-type": "CalculationStatusRoot" + "response-type": "DocumentDirectoriesRoot" } ] } }, - "/analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result": { + "/analytics/engines/afi/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 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": "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", + "default": "" } } ], "responses": { "200": { - "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.", - "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/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", + "description": "Expected response, returns a list of Axioma FI strategy documents and directories", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33206,10 +34042,49 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } + } + } + }, + "400": { + "description": "Invalid query parameter or value provided", + "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" } @@ -33217,7 +34092,7 @@ } }, "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "description": "Path not found", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33257,16 +34132,11 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, "401": { - "description": "Missing or invalid authentication.", + "description": "Missing or invalid authentication", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33321,6 +34191,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 +34273,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 +34296,19 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "ObjectRoot" + "response-type": "DocumentDirectoriesRoot" } ] } }, - "/analytics/engines/axp/v3/strategies/{path}": { + "/analytics/engines/bpm/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 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", @@ -33392,7 +34324,7 @@ ], "responses": { "200": { - "description": "Expected response, returns a list of Axioma Equity 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.", @@ -33689,14 +34621,14 @@ ] } }, - "/analytics/engines/afi/v3/strategies/{path}": { + "/analytics/engines/npo/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 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", @@ -33712,7 +34644,7 @@ ], "responses": { "200": { - "description": "Expected response, returns a list of Axioma FI 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.", @@ -34009,14 +34941,14 @@ ] } }, - "/analytics/engines/bpm/v3/strategies/{path}": { + "/analytics/engines/fpo/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 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", @@ -34032,7 +34964,7 @@ ], "responses": { "200": { - "description": "Expected response, returns a list of Barra 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.", @@ -34329,30 +35261,28 @@ ] } }, - "/analytics/engines/npo/v3/strategies/{path}": { - "get": { + "/analytics/engines/pa/v3/templated-components": { + "post": { "tags": [ - "StrategyDocuments" + "TemplatedPAComponents" ], - "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", - "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 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" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { - "description": "Expected response, returns a list of Northfield strategy documents and directories", + "201": { + "description": "Expected response, templated PA component created successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34388,15 +35318,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.", @@ -34432,15 +35372,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.", @@ -34474,36 +35443,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.", @@ -34540,7 +35483,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.", @@ -34602,7 +35545,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.", @@ -34621,7 +35564,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.", @@ -34643,36 +35586,33 @@ "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/fpo/v3/strategies/{path}": { + }, "get": { "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", + "summary": "Get templated PA components in path", + "description": "This endpoint returns the list of templated PA components in path.", + "operationId": "getTemplatedPAComponentsInPath", "parameters": [ { - "name": "path", - "in": "path", - "description": "The directory to get the strategy documents and sub-directories in", + "name": "directory", + "in": "query", + "description": "Get templated PA components in path", "required": true, "schema": { "type": "string", - "description": "The directory to get the strategy documents and sub-directories in", - "default": "" + "description": "Get templated PA components in path" } } ], "responses": { "200": { - "description": "Expected response, returns a list of FactSet Portfolio Optimizer strategy documents and directories", + "description": "Expected response, returns a list templated PA components.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34710,57 +35650,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" } } } }, "400": { - "description": "Invalid query parameter or value 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" - } - } - } - }, - "404": { - "description": "Path not found", + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34804,7 +35700,7 @@ } }, "401": { - "description": "Missing or invalid authentication", + "description": "Missing or invalid authentication.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34860,7 +35756,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 +35818,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 +35837,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.", @@ -34964,33 +35860,45 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "DocumentDirectoriesRoot" + "response-type": "TemplatedPAComponentSummaryRoot" } ] } }, - "/analytics/engines/pa/v3/templated-components": { - "post": { + "/analytics/engines/pa/v3/templated-components/{id}": { + "put": { "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", + "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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "updateTemplatedPAComponents", + "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" + } + } + ], "requestBody": { "description": "Request Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentParametersRoot" + "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" } } }, "required": true }, "responses": { - "201": { - "description": "Expected response, templated PA component created successfully.", + "200": { + "description": "Expected response, updated successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35026,25 +35934,159 @@ } }, "content": { - "text/plain": { + "application/json": { "schema": { "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } + } + } + }, + "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/TemplatedPAComponentPostSummaryRoot" + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "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." } }, - "text/json": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + "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" } } } }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "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.", @@ -35078,27 +36120,10 @@ "type": "string" } } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "401": { - "description": "Missing or invalid authentication.", + "429": { + "description": "Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35113,11 +36138,17 @@ "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" + } } } }, - "403": { - "description": "User is forbidden with current credentials", + "500": { + "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35132,29 +36163,11 @@ "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" - } } } }, - "404": { - "description": "Template not found.", + "503": { + "description": "Request timed out. Retry the request in sometime.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35169,29 +36182,40 @@ "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.", + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "TemplatedPAComponentPostSummaryRoot" + } + ] + }, + "get": { + "tags": [ + "TemplatedPAComponents" + ], + "summary": "Get templated PA component by id", + "description": "This endpoint fetches the templated PA component settings.", + "operationId": "getTemplatedPAComponentById", + "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" + } + } + ], + "responses": { + "200": { + "description": "Expected response, templated PA component details.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35225,102 +36249,17 @@ "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.", + }, + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/TemplatedPAComponentRoot" } } } }, - "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": "201", - "response-type": "TemplatedPAComponentPostSummaryRoot" - } - ] - }, - "get": { - "tags": [ - "TemplatedPAComponents" - ], - "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" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list templated PA components.", + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35358,13 +36297,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "404": { + "description": "Templated PA component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35568,19 +36507,17 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "TemplatedPAComponentSummaryRoot" + "response-type": "TemplatedPAComponentRoot" } ] - } - }, - "/analytics/engines/pa/v3/templated-components/{id}": { - "put": { + }, + "delete": { "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": "Delete templated PA component", + "description": "This endpoint deletes an existing templated PA component", + "operationId": "deleteTemplatedPAComponents", "parameters": [ { "name": "id", @@ -35593,20 +36530,9 @@ } } ], - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" - } - } - }, - "required": true - }, "responses": { - "200": { - "description": "Expected response, updated successfully.", + "204": { + "description": "Expected response, deleted the templated PA component successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35640,13 +36566,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" - } - } } }, "400": { @@ -35686,15 +36605,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": "Component or template not found.", + "description": "Component not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35730,10 +36659,20 @@ } }, "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, @@ -35897,33 +36836,34 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "TemplatedPAComponentPostSummaryRoot" + "status-code": "204", + "response-type": null } ] - }, - "get": { + } + }, + "/analytics/engines/pa/v3/unlinked-templates": { + "post": { "tags": [ - "TemplatedPAComponents" + "UnlinkedPATemplates" ], - "summary": "Get templated PA component by id", - "description": "This endpoint fetches the templated PA component settings.", - "operationId": "getTemplatedPAComponentById", - "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" + "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 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" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { - "description": "Expected response, templated PA component details.", + "201": { + "description": "Expected response, created a unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35961,7 +36901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentRoot" + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } @@ -36010,50 +36950,6 @@ } } }, - "404": { - "description": "Templated PA component 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": { @@ -36214,70 +37110,41 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "TemplatedPAComponentRoot" + "status-code": "201", + "response-type": "UnlinkedPATemplatePostSummaryRoot" } ] }, - "delete": { + "get": { "tags": [ - "TemplatedPAComponents" + "UnlinkedPATemplates" ], - "summary": "Delete templated PA component", - "description": "This endpoint deletes an existing templated PA component", - "operationId": "deleteTemplatedPAComponents", + "summary": "Get unlinked PA templates", + "description": "This endpoint returns the list of unlinked PA templates.", + "operationId": "getUnlinkedPATemplates", "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for a templated PA component", - "required": true, + "name": "directory", + "in": "query", + "description": "Get unlinked PA templates in path.", "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Get unlinked PA templates in path." + } + }, + { + "name": "category", + "in": "query", + "description": "Get unlinked PA templates by category.", + "schema": { + "type": "string", + "description": "Get unlinked PA templates by category." } } ], "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" - } - } - } - }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "200": { + "description": "Expected response, returns a list of unlinked PA templates.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36313,25 +37180,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/UnlinkedPATemplateSummaryRoot" } } } }, - "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 +37224,10 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -36544,78 +37391,46 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "UnlinkedPATemplateSummaryRoot" } ] } }, - "/analytics/engines/pa/v3/unlinked-templates": { - "post": { + "/analytics/engines/pa/v3/unlinked-templates/{id}": { + "put": { "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", + "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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "updateUnlinkedPATemplates", + "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" + } + } + ], "requestBody": { "description": "Request Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" } } }, "required": true }, "responses": { - "201": { - "description": "Expected response, created a 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/UnlinkedPATemplatePostSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "200": { + "description": "Expected response, updated the unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36653,206 +37468,13 @@ "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." + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "UnlinkedPATemplatePostSummaryRoot" - } - ] - }, - "get": { - "tags": [ - "UnlinkedPATemplates" - ], - "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." - } }, - { - "name": "category", - "in": "query", - "description": "Get unlinked PA templates by category.", - "schema": { - "type": "string", - "description": "Get unlinked PA templates by category." - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of unlinked PA templates.", + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36890,13 +37512,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "404": { + "description": "Template not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37100,19 +37722,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", @@ -37125,20 +37745,9 @@ } } ], - "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 +37781,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" - } - } } }, "400": { @@ -37429,18 +38031,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", @@ -37454,8 +38056,8 @@ } ], "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 +38091,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateRoot" + } + } } }, "400": { @@ -37739,121 +38348,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 +38402,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" } } } @@ -38057,22 +38568,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 +38633,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,34 +38887,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" } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "nullable": true + } + } + }, + "encoding": { + "file": { + "style": "form" + } + } + } + } + }, "responses": { "200": { - "description": "Expected response, details of the unlinked PA template type", + "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.", @@ -38341,57 +38971,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "$ref": "#/components/schemas/VaultAttributionLoaderResponseRoot" } } } }, "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.", + "description": "Bad Request", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -38595,7 +39181,7 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "response-type": "VaultAttributionLoaderResponseRoot" } ] } @@ -41137,8 +41723,7 @@ "id": { "type": "string" } - }, - "additionalProperties": false + } }, "SPARAccounts": { "type": "object", @@ -41150,8 +41735,7 @@ }, "description": "List of SPAR returnsType" } - }, - "additionalProperties": false + } }, "SPARAccountsRoot": { "required": [ @@ -41165,8 +41749,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ErrorSource": { "type": "object", @@ -41177,8 +41760,7 @@ "parameter": { "type": "string" } - }, - "additionalProperties": false + } }, "Error": { "type": "object", @@ -41186,14 +41768,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 +41791,7 @@ "$ref": "#/components/schemas/Error" } } - }, - "additionalProperties": false + } }, "AccountDirectories": { "type": "object", @@ -41224,8 +41810,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "AccountDirectoriesRoot": { "required": [ @@ -41239,8 +41824,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategyOverrides": { "type": "object", @@ -41272,8 +41856,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategy": { "required": [ @@ -41288,8 +41871,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "OptimizerAccountOverrides": { "type": "object", @@ -41310,8 +41892,7 @@ "type": "string", "description": "Currency" } - }, - "additionalProperties": false + } }, "OptimizerAccount": { "type": "object", @@ -41323,8 +41904,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "Optimization": { "type": "object", @@ -41341,8 +41921,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "OptimizerTradesList": { "type": "object", @@ -41367,8 +41946,7 @@ "type": "boolean", "description": "Include cash" } - }, - "additionalProperties": false + } }, "OptimizerOptimalHoldings": { "type": "object", @@ -41397,8 +41975,7 @@ "type": "boolean", "description": "Exclude zero" } - }, - "additionalProperties": false + } }, "OptimalPortfolio": { "type": "object", @@ -41433,12 +42010,10 @@ "type": "string", "description": "Action if ofdb date exists" } - }, - "additionalProperties": false + } }, "OptimizerStats": { - "type": "object", - "additionalProperties": false + "type": "object" }, "OptimizerOutputTypes": { "type": "object", @@ -41455,8 +42030,7 @@ "stats": { "$ref": "#/components/schemas/OptimizerStats" } - }, - "additionalProperties": false + } }, "AFIOptimizationParameters": { "required": [ @@ -41477,12 +42051,10 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "OptimizerCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "AFIOptimizationParametersRoot": { "type": "object", @@ -41493,8 +42065,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationInfo": { "type": "object", @@ -41503,8 +42074,7 @@ "type": "string", "description": "Calculation identifier" } - }, - "additionalProperties": false + } }, "CalculationInfoRoot": { "required": [ @@ -41518,8 +42088,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ObjectRoot": { "required": [ @@ -41533,8 +42102,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategyOverrides": { "type": "object", @@ -41566,8 +42134,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategy": { "required": [ @@ -41582,8 +42149,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParameters": { "required": [ @@ -41604,8 +42170,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParametersRoot": { "type": "object", @@ -41616,8 +42181,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARIdentifier": { "required": [ @@ -41638,7 +42202,6 @@ "description": "Benchmark prefix." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for SPAR calculation." }, "SPARBenchmark": { @@ -41659,8 +42222,7 @@ }, "description": "List of SPAR identifiers" } - }, - "additionalProperties": false + } }, "SPARBenchmarkRoot": { "required": [ @@ -41674,8 +42236,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ConstraintAction": { "type": "object", @@ -41690,8 +42251,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyAlphaOverride": { "type": "object", @@ -41712,8 +42272,7 @@ "returnMultiplier": { "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyOverrides": { "type": "object", @@ -41736,8 +42295,7 @@ "type": "string", "description": "Transaction cost\r\nCan be set to \"\" for local" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategy": { "required": [ @@ -41752,8 +42310,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "BPMOptimization": { "type": "object", @@ -41778,8 +42335,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "BPMOptimizationParameters": { "required": [ @@ -41800,8 +42356,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "BPMOptimizationParametersRoot": { "type": "object", @@ -41812,8 +42367,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "ColumnSummary": { "type": "object", @@ -41831,7 +42385,6 @@ "description": "Column Category" } }, - "additionalProperties": false, "description": "Column settings (name, directory, category)" }, "ColumnSummaryRoot": { @@ -41849,8 +42402,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Column": { "type": "object", @@ -41874,8 +42426,7 @@ "type": "string", "description": "Column Category" } - }, - "additionalProperties": false + } }, "ColumnRoot": { "required": [ @@ -41889,8 +42440,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ColumnStatistic": { "type": "object", @@ -41899,8 +42449,7 @@ "type": "string", "description": "Column Statistic Name" } - }, - "additionalProperties": false + } }, "ColumnStatisticRoot": { "required": [ @@ -41917,8 +42466,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ComponentSummary": { "type": "object", @@ -41931,8 +42479,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "ComponentSummaryRoot": { "required": [ @@ -41949,8 +42496,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "PAIdentifier": { "required": [ @@ -41966,8 +42512,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PADateParameters": { "required": [ @@ -41989,7 +42534,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for PA calculation." }, "PAComponent": { @@ -42035,8 +42579,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "PAComponentRoot": { "required": [ @@ -42050,8 +42593,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 +42649,6 @@ "description": "User's FactSet account path OR benchmark." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for Vault calculation." }, "VaultDateParameters": { @@ -42087,7 +42671,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for Vault calculation" }, "VaultComponent": { @@ -42126,8 +42709,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "VaultComponentRoot": { "required": [ @@ -42141,8 +42723,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "VaultConfigurationSummary": { "type": "object", @@ -42151,8 +42732,7 @@ "type": "string", "description": "Configuration name." } - }, - "additionalProperties": false + } }, "VaultConfigurationSummaryRoot": { "required": [ @@ -42169,8 +42749,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "ConfigurationAccount": { "type": "object", @@ -42199,8 +42778,7 @@ "type": "string", "description": "Account name." } - }, - "additionalProperties": false + } }, "VaultConfiguration": { "type": "object", @@ -42215,8 +42793,7 @@ "$ref": "#/components/schemas/ConfigurationAccount" } } - }, - "additionalProperties": false + } }, "VaultConfigurationRoot": { "required": [ @@ -42230,8 +42807,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Currency": { "type": "object", @@ -42240,8 +42816,7 @@ "type": "string", "description": "Name of currency." } - }, - "additionalProperties": false + } }, "CurrencyRoot": { "required": [ @@ -42258,8 +42833,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "DateParametersSummary": { "type": "object", @@ -42272,8 +42846,7 @@ "type": "string", "description": "End date in YYYYMMDD format." } - }, - "additionalProperties": false + } }, "DateParametersSummaryRoot": { "required": [ @@ -42287,8 +42860,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfo": { "type": "object", @@ -42302,8 +42874,7 @@ "currency": { "type": "string" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfoRoot": { "required": [ @@ -42320,8 +42891,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "DocumentDirectories": { "type": "object", @@ -42340,8 +42910,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "DocumentDirectoriesRoot": { "required": [ @@ -42355,8 +42924,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "FIABIdentifier": { "required": [ @@ -42368,8 +42936,7 @@ "type": "string", "description": "User's FactSet account path." } - }, - "additionalProperties": false + } }, "FIABDateParameters": { "required": [ @@ -42387,7 +42954,6 @@ "description": "Calculation's end date." } }, - "additionalProperties": false, "description": "The date parameters for FIAB calculations." }, "FIABCalculationParameters": { @@ -42415,8 +42981,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 +42996,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "EventSummary": { "type": "object", @@ -42450,8 +43014,7 @@ "type": "string", "description": "Event's type" } - }, - "additionalProperties": false + } }, "FIABCalculationStatus": { "type": "object", @@ -42494,8 +43057,7 @@ }, "description": "List of batch events" } - }, - "additionalProperties": false + } }, "FIReferencePrepay": { "type": "object", @@ -42504,8 +43066,7 @@ "type": "string", "description": "Reference Prepay Name" } - }, - "additionalProperties": false + } }, "FIReferenceSecurity": { "type": "object", @@ -42534,8 +43095,7 @@ "type": "string", "description": "Reference Settlement Date" } - }, - "additionalProperties": false + } }, "FIBankLoans": { "type": "object", @@ -42544,8 +43104,7 @@ "type": "boolean", "description": "Ignore Sinking Fund" } - }, - "additionalProperties": false + } }, "FIMunicipalBonds": { "type": "object", @@ -42558,8 +43117,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FILoss": { "type": "object", @@ -42568,8 +43126,7 @@ "type": "string", "description": "Loss Name" } - }, - "additionalProperties": false + } }, "FIPrepay": { "type": "object", @@ -42578,8 +43135,7 @@ "type": "string", "description": "Prepay Name" } - }, - "additionalProperties": false + } }, "FIServicerAdvancesForSecurities": { "type": "object", @@ -42605,8 +43161,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIPrepayLockout": { "type": "object", @@ -42629,8 +43184,7 @@ "type": "string", "description": "Ym Above" } - }, - "additionalProperties": false + } }, "FICashflows": { "type": "object", @@ -42657,8 +43211,7 @@ "description": "RecoveryLag", "format": "int32" } - }, - "additionalProperties": false + } }, "FIBalloonExtension": { "type": "object", @@ -42691,8 +43244,7 @@ "description": "Coupon Stepup", "format": "double" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForSecurities": { "type": "object", @@ -42721,8 +43273,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 +43359,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 +43394,7 @@ "type": "string", "description": "Discount curve" } - }, - "additionalProperties": false + } }, "FIMunicipalBondsForJobSettings": { "type": "object", @@ -42823,8 +43411,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FIMarketEnvironment": { "type": "object", @@ -42839,8 +43426,7 @@ "description": "Rate Path", "default": "FLAT & FORWARD" } - }, - "additionalProperties": false + } }, "FIServicerAdvances": { "type": "object", @@ -42856,8 +43442,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForJobSettings": { "type": "object", @@ -42886,8 +43471,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 +43533,11 @@ }, "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" + }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForJobSettings" } - }, - "additionalProperties": false + } }, "FICalculationParameters": { "required": [ @@ -42965,8 +43564,7 @@ "jobSettings": { "$ref": "#/components/schemas/FIJobSettings" } - }, - "additionalProperties": false + } }, "CalculationMeta": { "type": "object", @@ -43016,8 +43614,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "FICalculationParametersRoot": { "type": "object", @@ -43028,8 +43625,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PaDoc": { "required": [ @@ -43041,8 +43637,7 @@ "type": "string", "description": "PA document path" } - }, - "additionalProperties": false + } }, "FPOAccount": { "required": [ @@ -43060,8 +43655,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "FPOObjective": { "type": "object", @@ -43079,8 +43673,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategyOverrides": { "type": "object", @@ -43107,8 +43700,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategy": { "required": [ @@ -43123,8 +43715,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "FPOOptimizationParameters": { "required": [ @@ -43145,8 +43736,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "FPOOptimizationParametersRoot": { "type": "object", @@ -43157,8 +43747,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "Frequency": { "type": "object", @@ -43167,8 +43756,7 @@ "type": "string", "description": "Frequency name." } - }, - "additionalProperties": false + } }, "FrequencyRoot": { "required": [ @@ -43185,8 +43773,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "Group": { "type": "object", @@ -43203,8 +43790,7 @@ "type": "string", "description": "Group Category" } - }, - "additionalProperties": false + } }, "GroupRoot": { "required": [ @@ -43221,8 +43807,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplateContentTypes": { "type": "object", @@ -43248,8 +43833,7 @@ }, "description": "Template locked fields" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParameters": { "required": [ @@ -43273,8 +43857,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParametersRoot": { "required": [ @@ -43288,8 +43871,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummary": { "type": "object", @@ -43310,8 +43892,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummaryRoot": { "required": [ @@ -43325,8 +43906,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummary": { "type": "object", @@ -43343,8 +43923,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummaryRoot": { "required": [ @@ -43361,8 +43940,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParameters": { "type": "object", @@ -43378,8 +43956,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParametersRoot": { "required": [ @@ -43393,8 +43970,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "LinkedPATemplate": { "type": "object", @@ -43426,8 +44002,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateRoot": { "required": [ @@ -43441,8 +44016,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategyOverrides": { "type": "object", @@ -43473,8 +44047,7 @@ "type": "string", "description": "Alpha" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategy": { "required": [ @@ -43489,8 +44062,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "NPOOptimizationParameters": { "required": [ @@ -43511,8 +44083,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "NPOOptimizationParametersRoot": { "type": "object", @@ -43523,8 +44094,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "PACalculationGroup": { "type": "object", @@ -43537,8 +44107,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "PACalculationColumn": { "type": "object", @@ -43554,8 +44123,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "PACalculationPricingSource": { "type": "object", @@ -43564,8 +44132,7 @@ "type": "string", "description": "Pricing source identifier" } - }, - "additionalProperties": false + } }, "PACalculationDataSources": { "type": "object", @@ -43588,8 +44155,7 @@ "type": "boolean", "description": "Use portfolio pricing sources for benchmark" } - }, - "additionalProperties": false + } }, "PACalculationParameters": { "required": [ @@ -43643,8 +44209,7 @@ "type": "string", "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "PACalculationParametersRoot": { "type": "object", @@ -43659,8 +44224,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationUnitStatus": { "type": "object", @@ -43695,9 +44259,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 +44293,7 @@ }, "description": "Number of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationUnitStatusMeta": { "type": "object", @@ -43733,8 +44302,7 @@ "type": "string", "description": "The Info URL of the calculation." } - }, - "additionalProperties": false + } }, "CalculationStatusMeta": { "type": "object", @@ -43746,8 +44314,7 @@ }, "description": "Meta of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationStatusRoot": { "required": [ @@ -43761,8 +44328,7 @@ "meta": { "$ref": "#/components/schemas/CalculationStatusMeta" } - }, - "additionalProperties": false + } }, "CalculationsSummary": { "type": "object", @@ -43792,8 +44358,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "PaginationInfo": { "type": "object", @@ -43820,8 +44385,7 @@ "previousPage": { "type": "string" } - }, - "additionalProperties": false + } }, "PaginationMeta": { "type": "object", @@ -43829,8 +44393,7 @@ "pagination": { "$ref": "#/components/schemas/PaginationInfo" } - }, - "additionalProperties": false + } }, "CalculationsSummaryRoot": { "required": [ @@ -43844,8 +44407,7 @@ "meta": { "$ref": "#/components/schemas/PaginationMeta" } - }, - "additionalProperties": false + } }, "PAPricingSource": { "type": "object", @@ -43862,8 +44424,7 @@ "type": "string", "description": "Pricing source category" } - }, - "additionalProperties": false + } }, "PAPricingSourceRoot": { "required": [ @@ -43880,8 +44441,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "PubIdentifier": { "required": [ @@ -43897,8 +44457,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PubDateParameters": { "required": [ @@ -43915,7 +44474,6 @@ "description": "Calculation's end date or as of date." } }, - "additionalProperties": false, "description": "The date parameters for Publisher calculation." }, "PubCalculationParameters": { @@ -43936,12 +44494,10 @@ "dates": { "$ref": "#/components/schemas/PubDateParameters" } - }, - "additionalProperties": false + } }, "PubCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "PubCalculationParametersRoot": { "type": "object", @@ -43956,8 +44512,7 @@ "meta": { "$ref": "#/components/schemas/PubCalculationMeta" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverse": { "required": [ @@ -43984,8 +44539,7 @@ "securityExpr": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverse": { "required": [ @@ -44012,8 +44566,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantUniverse": { "required": [ @@ -44029,8 +44582,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverse": { "required": [ @@ -44046,8 +44598,7 @@ "screen": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantDateList": { "type": "object", @@ -44063,8 +44614,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantDate": { "required": [ @@ -44090,8 +44640,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantFdsDate": { "required": [ @@ -44111,8 +44660,7 @@ "endDate": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpression": { "required": [ @@ -44138,8 +44686,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameter": { "required": [ @@ -44159,8 +44706,7 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParameters": { "type": "object", @@ -44168,8 +44714,7 @@ { "$ref": "#/components/schemas/QuantFormula" } - ], - "additionalProperties": false + ] }, "QuantFormula": { "required": [ @@ -44186,8 +44731,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpression": { "required": [ @@ -44210,8 +44754,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverseObsolete": { "required": [ @@ -44241,8 +44784,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverseObsolete": { "required": [ @@ -44261,8 +44803,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverseObsolete": { "required": [ @@ -44292,8 +44833,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantFdsDateObsolete": { "required": [ @@ -44319,8 +44859,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantDateListObsolete": { "required": [ @@ -44344,8 +44883,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionObsolete": { "required": [ @@ -44363,8 +44901,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpressionObsolete": { "required": [ @@ -44385,8 +44922,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameterObsolete": { "required": [ @@ -44401,12 +44937,10 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParametersObsolete": { - "type": "object", - "additionalProperties": false + "type": "object" }, "OneOfQuantUniverse": { "oneOf": [ @@ -44492,8 +45026,7 @@ "jobDescription": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantCalculationMeta": { "type": "object", @@ -44546,8 +45079,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "QuantCalculationParametersRoot": { "type": "object", @@ -44562,8 +45094,7 @@ "meta": { "$ref": "#/components/schemas/QuantCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARDateParameters": { "required": [ @@ -44586,7 +45117,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for SPAR calculation." }, "SPARCalculationParameters": { @@ -44616,8 +45146,7 @@ "type": "string", "description": "Currency ISO code for calculation." } - }, - "additionalProperties": false + } }, "SPARCalculationParametersRoot": { "type": "object", @@ -44632,8 +45161,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PAComponentData": { "type": "object", @@ -44678,10 +45206,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 +45232,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParametersRoot": { "required": [ @@ -44720,8 +45246,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummary": { "type": "object", @@ -44741,8 +45266,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummaryRoot": { "required": [ @@ -44756,8 +45280,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummary": { "type": "object", @@ -44774,8 +45297,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummaryRoot": { "required": [ @@ -44792,8 +45314,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParameters": { "type": "object", @@ -44809,8 +45330,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParametersRoot": { "required": [ @@ -44824,8 +45344,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "TemplatedPAComponent": { "type": "object", @@ -44854,8 +45373,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentRoot": { "required": [ @@ -44869,8 +45387,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParameters": { "required": [ @@ -44931,13 +45448,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 +45467,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummary": { "type": "object", @@ -44973,8 +45488,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummaryRoot": { "required": [ @@ -44988,8 +45502,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummary": { "type": "object", @@ -45006,8 +45519,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummaryRoot": { "required": [ @@ -45024,8 +45536,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParameters": { "type": "object", @@ -45074,13 +45585,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 +45604,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplate": { "type": "object", @@ -45156,7 +45665,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 +45682,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateRoot": { "required": [ @@ -45188,8 +45696,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndType": { "type": "object", @@ -45202,8 +45709,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeRoot": { "required": [ @@ -45220,8 +45726,7 @@ "meta": { "type": "object" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateColumnDetails": { "type": "object", @@ -45241,8 +45746,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateGroupDetails": { "type": "object", @@ -45259,8 +45763,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetails": { "type": "object", @@ -45295,8 +45798,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { "required": [ @@ -45310,8 +45812,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": [ @@ -45339,8 +45871,7 @@ "type": "string", "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "VaultCalculationParametersRoot": { "type": "object", @@ -45355,8 +45886,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } } }, "securitySchemes": { diff --git a/openapi-schema.json b/openapi-schema.json index 555651a..fb35fca 100644 --- a/openapi-schema.json +++ b/openapi-schema.json @@ -8750,6 +8750,325 @@ ] } }, + "/analytics/engines/spar/v3/components/{id}": { + "get": { + "tags": [ + "Components" + ], + "summary": "Get SPAR component by id", + "description": "This endpoint returns the default settings of a SPAR component.", + "operationId": "getSPARComponentById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a SPAR component", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a SPAR component" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the default settings of a SPAR component.", + "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/SPARComponentRoot" + } + } + } + }, + "400": { + "description": "Invalid SPAR component id.", + "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": "Component 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": { + "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": "SPARComponentRoot" + } + ] + } + }, "/analytics/engines/vault/v3/components": { "get": { "tags": [ @@ -22442,7 +22761,7 @@ "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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "postAndCalculate", "parameters": [ { @@ -23240,7 +23559,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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.", "operationId": "putAndCalculate", "parameters": [ { @@ -28023,111 +28342,6 @@ } }, "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": { - "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/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - } - } - }, - "201": { - "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, "200": { "description": "Expected response if the calculation has one unit and is completed with an error.", "headers": { @@ -28169,16 +28383,11 @@ "schema": { "$ref": "#/components/schemas/CalculationStatusRoot" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } } } }, - "400": { - "description": "Invalid calculation parameters.", + "201": { + "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -28214,21 +28423,24 @@ } }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "format": "binary" } } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "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": { @@ -28265,10 +28477,49 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } + } + }, + "400": { + "description": "Invalid calculation parameters.", + "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" } @@ -28331,6 +28582,94 @@ } } }, + "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" + } + } + } + }, + "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" + } + } + } + }, "415": { "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", "headers": { @@ -28453,15 +28792,16 @@ "x-are-multiple-success-responses-different": true, "x-success-response-types": [ { - "status-code": "202", + "status-code": "200", "response-type": "CalculationStatusRoot" }, { "status-code": "201", - "response-type": "ObjectRoot" + "response-type": null, + "is-file": true }, { - "status-code": "200", + "status-code": "202", "response-type": "CalculationStatusRoot" } ] @@ -28823,16 +29163,9 @@ } }, "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", + "200": { + "description": "Expected response if the calculation has one unit and is completed with an error.", "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", "schema": { @@ -28871,16 +29204,11 @@ "schema": { "$ref": "#/components/schemas/CalculationStatusRoot" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } } } }, - "200": { - "description": "Expected response if the calculation has one unit and is completed with an error.", + "201": { + "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -28916,21 +29244,24 @@ } }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "type": "string", + "format": "binary" } } } }, - "201": { - "description": "Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters.", + "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": { @@ -28967,12 +29298,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$ref": "#/components/schemas/CalculationStatusRoot" } } } @@ -29018,10 +29344,61 @@ "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." + } }, - "application/x-protobuf": { + "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." + } + } + } + }, + "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" } } } @@ -29067,11 +29444,6 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -29116,35 +29488,11 @@ "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", + "413": { + "description": "Request body too large", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -29178,6 +29526,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "415": { @@ -29301,17 +29656,18 @@ }, "x-are-multiple-success-responses-different": true, "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, { "status-code": "200", "response-type": "CalculationStatusRoot" }, { "status-code": "201", - "response-type": "ObjectRoot" + "response-type": null, + "is-file": true + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" } ] }, @@ -30289,18 +30645,6 @@ } }, "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/octet-stream": { "schema": { "type": "string", @@ -30350,21 +30694,30 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "FactSet's request key header." } }, - "application/octet-stream": { + "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." } } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30398,46 +30751,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/octet-stream": { - "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": "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.", @@ -30471,6 +30788,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "500": { @@ -30611,18 +30935,6 @@ } }, "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/octet-stream": { "schema": { "type": "string", @@ -30672,21 +30984,30 @@ "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "application/x-protobuf": { + } + } + }, + "401": { + "description": "Missing or invalid authentication.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "FactSet's request key header." } }, - "application/octet-stream": { + "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." } } } }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -30720,46 +31041,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/octet-stream": { - "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": "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.", @@ -30793,6 +31078,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, "500": { @@ -34975,7 +35267,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 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", @@ -35579,7 +35871,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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "updateTemplatedPAComponents", "parameters": [ { @@ -36556,7 +36848,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 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", @@ -37111,7 +37403,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 gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", "operationId": "updateUnlinkedPATemplates", "parameters": [ { @@ -38341,13 +38633,57 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "$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" } } } }, - "400": { - "description": "Invalid data provided. Please check the request parameters before attempting again.", + "404": { + "description": "Unlinked PA template type not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -38390,8 +38726,258 @@ } } }, - "404": { - "description": "Unlinked PA template type 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.", + "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": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/load/{batchId}": { + "post": { + "tags": [ + "Vault Attribution Loader" + ], + "summary": "Vault - External Attribution Loader", + "description": "This endpoint loads Vault External Attributions.", + "operationId": "vaultAttributionLoader", + "parameters": [ + { + "name": "batchId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "nullable": true + } + } + }, + "encoding": { + "file": { + "style": "form" + } + } + } + } + }, + "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.", + "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.", @@ -38595,7 +39181,7 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "response-type": "VaultAttributionLoaderResponseRoot" } ] } @@ -41137,8 +41723,7 @@ "id": { "type": "string" } - }, - "additionalProperties": false + } }, "SPARAccounts": { "type": "object", @@ -41150,8 +41735,7 @@ }, "description": "List of SPAR returnsType" } - }, - "additionalProperties": false + } }, "SPARAccountsRoot": { "required": [ @@ -41163,8 +41747,7 @@ "$ref": "#/components/schemas/SPARAccounts" }, "meta": { } - }, - "additionalProperties": false + } }, "ErrorSource": { "type": "object", @@ -41175,8 +41758,7 @@ "parameter": { "type": "string" } - }, - "additionalProperties": false + } }, "Error": { "type": "object", @@ -41184,14 +41766,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 +41789,7 @@ "$ref": "#/components/schemas/Error" } } - }, - "additionalProperties": false + } }, "AccountDirectories": { "type": "object", @@ -41222,8 +41808,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "AccountDirectoriesRoot": { "required": [ @@ -41235,8 +41820,7 @@ "$ref": "#/components/schemas/AccountDirectories" }, "meta": { } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategyOverrides": { "type": "object", @@ -41268,8 +41852,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AFIOptimizerStrategy": { "required": [ @@ -41284,8 +41867,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "OptimizerAccountOverrides": { "type": "object", @@ -41306,8 +41888,7 @@ "type": "string", "description": "Currency" } - }, - "additionalProperties": false + } }, "OptimizerAccount": { "type": "object", @@ -41319,8 +41900,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "Optimization": { "type": "object", @@ -41337,8 +41917,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "OptimizerTradesList": { "type": "object", @@ -41363,8 +41942,7 @@ "type": "boolean", "description": "Include cash" } - }, - "additionalProperties": false + } }, "OptimizerOptimalHoldings": { "type": "object", @@ -41393,8 +41971,7 @@ "type": "boolean", "description": "Exclude zero" } - }, - "additionalProperties": false + } }, "OptimalPortfolio": { "type": "object", @@ -41429,12 +42006,10 @@ "type": "string", "description": "Action if ofdb date exists" } - }, - "additionalProperties": false + } }, "OptimizerStats": { - "type": "object", - "additionalProperties": false + "type": "object" }, "OptimizerOutputTypes": { "type": "object", @@ -41451,8 +42026,7 @@ "stats": { "$ref": "#/components/schemas/OptimizerStats" } - }, - "additionalProperties": false + } }, "AFIOptimizationParameters": { "required": [ @@ -41473,12 +42047,10 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "OptimizerCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "AFIOptimizationParametersRoot": { "type": "object", @@ -41489,8 +42061,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationInfo": { "type": "object", @@ -41499,8 +42070,7 @@ "type": "string", "description": "Calculation identifier" } - }, - "additionalProperties": false + } }, "CalculationInfoRoot": { "required": [ @@ -41512,8 +42082,7 @@ "$ref": "#/components/schemas/CalculationInfo" }, "meta": { } - }, - "additionalProperties": false + } }, "ObjectRoot": { "required": [ @@ -41523,8 +42092,7 @@ "properties": { "data": { }, "meta": { } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategyOverrides": { "type": "object", @@ -41556,8 +42124,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizerStrategy": { "required": [ @@ -41572,8 +42139,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParameters": { "required": [ @@ -41594,8 +42160,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "AxiomaEquityOptimizationParametersRoot": { "type": "object", @@ -41606,8 +42171,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARIdentifier": { "required": [ @@ -41628,7 +42192,6 @@ "description": "Benchmark prefix." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for SPAR calculation." }, "SPARBenchmark": { @@ -41649,8 +42212,7 @@ }, "description": "List of SPAR identifiers" } - }, - "additionalProperties": false + } }, "SPARBenchmarkRoot": { "required": [ @@ -41662,8 +42224,7 @@ "$ref": "#/components/schemas/SPARBenchmark" }, "meta": { } - }, - "additionalProperties": false + } }, "ConstraintAction": { "type": "object", @@ -41678,8 +42239,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyAlphaOverride": { "type": "object", @@ -41700,8 +42260,7 @@ "returnMultiplier": { "type": "string" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategyOverrides": { "type": "object", @@ -41724,8 +42283,7 @@ "type": "string", "description": "Transaction cost\r\nCan be set to \"\" for local" } - }, - "additionalProperties": false + } }, "BPMOptimizerStrategy": { "required": [ @@ -41740,8 +42298,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "BPMOptimization": { "type": "object", @@ -41766,8 +42323,7 @@ "type": "string", "description": "Cash flow" } - }, - "additionalProperties": false + } }, "BPMOptimizationParameters": { "required": [ @@ -41788,8 +42344,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "BPMOptimizationParametersRoot": { "type": "object", @@ -41800,8 +42355,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "ColumnSummary": { "type": "object", @@ -41819,7 +42373,6 @@ "description": "Column Category" } }, - "additionalProperties": false, "description": "Column settings (name, directory, category)" }, "ColumnSummaryRoot": { @@ -41835,8 +42388,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "Column": { "type": "object", @@ -41860,8 +42412,7 @@ "type": "string", "description": "Column Category" } - }, - "additionalProperties": false + } }, "ColumnRoot": { "required": [ @@ -41873,8 +42424,7 @@ "$ref": "#/components/schemas/Column" }, "meta": { } - }, - "additionalProperties": false + } }, "ColumnStatistic": { "type": "object", @@ -41883,8 +42433,7 @@ "type": "string", "description": "Column Statistic Name" } - }, - "additionalProperties": false + } }, "ColumnStatisticRoot": { "required": [ @@ -41899,8 +42448,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "ComponentSummary": { "type": "object", @@ -41913,8 +42461,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "ComponentSummaryRoot": { "required": [ @@ -41929,8 +42476,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "PAIdentifier": { "required": [ @@ -41946,8 +42492,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PADateParameters": { "required": [ @@ -41969,7 +42514,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for PA calculation." }, "PAComponent": { @@ -42015,8 +42559,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "PAComponentRoot": { "required": [ @@ -42028,8 +42571,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 +42627,6 @@ "description": "User's FactSet account path OR benchmark." } }, - "additionalProperties": false, "description": "The account/benchmark parameter for Vault calculation." }, "VaultDateParameters": { @@ -42065,7 +42649,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for Vault calculation" }, "VaultComponent": { @@ -42104,8 +42687,7 @@ "type": "string", "description": "Component category." } - }, - "additionalProperties": false + } }, "VaultComponentRoot": { "required": [ @@ -42117,8 +42699,7 @@ "$ref": "#/components/schemas/VaultComponent" }, "meta": { } - }, - "additionalProperties": false + } }, "VaultConfigurationSummary": { "type": "object", @@ -42127,8 +42708,7 @@ "type": "string", "description": "Configuration name." } - }, - "additionalProperties": false + } }, "VaultConfigurationSummaryRoot": { "required": [ @@ -42143,8 +42723,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "ConfigurationAccount": { "type": "object", @@ -42173,8 +42752,7 @@ "type": "string", "description": "Account name." } - }, - "additionalProperties": false + } }, "VaultConfiguration": { "type": "object", @@ -42189,8 +42767,7 @@ "$ref": "#/components/schemas/ConfigurationAccount" } } - }, - "additionalProperties": false + } }, "VaultConfigurationRoot": { "required": [ @@ -42202,8 +42779,7 @@ "$ref": "#/components/schemas/VaultConfiguration" }, "meta": { } - }, - "additionalProperties": false + } }, "Currency": { "type": "object", @@ -42212,8 +42788,7 @@ "type": "string", "description": "Name of currency." } - }, - "additionalProperties": false + } }, "CurrencyRoot": { "required": [ @@ -42228,8 +42803,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "DateParametersSummary": { "type": "object", @@ -42242,8 +42816,7 @@ "type": "string", "description": "End date in YYYYMMDD format." } - }, - "additionalProperties": false + } }, "DateParametersSummaryRoot": { "required": [ @@ -42255,8 +42828,7 @@ "$ref": "#/components/schemas/DateParametersSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfo": { "type": "object", @@ -42270,8 +42842,7 @@ "currency": { "type": "string" } - }, - "additionalProperties": false + } }, "FIDiscountCurveInfoRoot": { "required": [ @@ -42286,8 +42857,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "DocumentDirectories": { "type": "object", @@ -42306,8 +42876,7 @@ }, "description": "List of directories." } - }, - "additionalProperties": false + } }, "DocumentDirectoriesRoot": { "required": [ @@ -42319,8 +42888,7 @@ "$ref": "#/components/schemas/DocumentDirectories" }, "meta": { } - }, - "additionalProperties": false + } }, "FIABIdentifier": { "required": [ @@ -42332,8 +42900,7 @@ "type": "string", "description": "User's FactSet account path." } - }, - "additionalProperties": false + } }, "FIABDateParameters": { "required": [ @@ -42351,7 +42918,6 @@ "description": "Calculation's end date." } }, - "additionalProperties": false, "description": "The date parameters for FIAB calculations." }, "FIABCalculationParameters": { @@ -42379,8 +42945,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 +42960,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "EventSummary": { "type": "object", @@ -42414,8 +42978,7 @@ "type": "string", "description": "Event's type" } - }, - "additionalProperties": false + } }, "FIABCalculationStatus": { "type": "object", @@ -42458,8 +43021,7 @@ }, "description": "List of batch events" } - }, - "additionalProperties": false + } }, "FIReferencePrepay": { "type": "object", @@ -42468,8 +43030,7 @@ "type": "string", "description": "Reference Prepay Name" } - }, - "additionalProperties": false + } }, "FIReferenceSecurity": { "type": "object", @@ -42498,8 +43059,7 @@ "type": "string", "description": "Reference Settlement Date" } - }, - "additionalProperties": false + } }, "FIBankLoans": { "type": "object", @@ -42508,8 +43068,7 @@ "type": "boolean", "description": "Ignore Sinking Fund" } - }, - "additionalProperties": false + } }, "FIMunicipalBonds": { "type": "object", @@ -42522,8 +43081,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FILoss": { "type": "object", @@ -42532,8 +43090,7 @@ "type": "string", "description": "Loss Name" } - }, - "additionalProperties": false + } }, "FIPrepay": { "type": "object", @@ -42542,8 +43099,7 @@ "type": "string", "description": "Prepay Name" } - }, - "additionalProperties": false + } }, "FIServicerAdvancesForSecurities": { "type": "object", @@ -42569,8 +43125,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIPrepayLockout": { "type": "object", @@ -42593,8 +43148,7 @@ "type": "string", "description": "Ym Above" } - }, - "additionalProperties": false + } }, "FICashflows": { "type": "object", @@ -42621,8 +43175,7 @@ "description": "RecoveryLag", "format": "int32" } - }, - "additionalProperties": false + } }, "FIBalloonExtension": { "type": "object", @@ -42655,8 +43208,7 @@ "description": "Coupon Stepup", "format": "double" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForSecurities": { "type": "object", @@ -42685,8 +43237,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 +43323,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 +43358,7 @@ "type": "string", "description": "Discount curve" } - }, - "additionalProperties": false + } }, "FIMunicipalBondsForJobSettings": { "type": "object", @@ -42787,8 +43375,7 @@ "type": "boolean", "description": "Anticipate Sink Schedule" } - }, - "additionalProperties": false + } }, "FIMarketEnvironment": { "type": "object", @@ -42803,8 +43390,7 @@ "description": "Rate Path", "default": "FLAT & FORWARD" } - }, - "additionalProperties": false + } }, "FIServicerAdvances": { "type": "object", @@ -42820,8 +43406,7 @@ "type": "string", "description": "Advance Type" } - }, - "additionalProperties": false + } }, "FIStructuredProductsForJobSettings": { "type": "object", @@ -42850,8 +43435,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 +43497,11 @@ }, "structuredProducts": { "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" + }, + "attribution": { + "$ref": "#/components/schemas/FIAttributionForJobSettings" } - }, - "additionalProperties": false + } }, "FICalculationParameters": { "required": [ @@ -42929,8 +43528,7 @@ "jobSettings": { "$ref": "#/components/schemas/FIJobSettings" } - }, - "additionalProperties": false + } }, "CalculationMeta": { "type": "object", @@ -42980,8 +43578,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "FICalculationParametersRoot": { "type": "object", @@ -42992,8 +43589,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PaDoc": { "required": [ @@ -43005,8 +43601,7 @@ "type": "string", "description": "PA document path" } - }, - "additionalProperties": false + } }, "FPOAccount": { "required": [ @@ -43024,8 +43619,7 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "additionalProperties": false + } }, "FPOObjective": { "type": "object", @@ -43043,8 +43637,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategyOverrides": { "type": "object", @@ -43071,8 +43664,7 @@ "type": "string", "description": "Transaction cost" } - }, - "additionalProperties": false + } }, "FPOOptimizerStrategy": { "required": [ @@ -43087,8 +43679,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "FPOOptimizationParameters": { "required": [ @@ -43109,8 +43700,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "FPOOptimizationParametersRoot": { "type": "object", @@ -43121,8 +43711,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "Frequency": { "type": "object", @@ -43131,8 +43720,7 @@ "type": "string", "description": "Frequency name." } - }, - "additionalProperties": false + } }, "FrequencyRoot": { "required": [ @@ -43147,8 +43735,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "Group": { "type": "object", @@ -43165,8 +43752,7 @@ "type": "string", "description": "Group Category" } - }, - "additionalProperties": false + } }, "GroupRoot": { "required": [ @@ -43181,8 +43767,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "TemplateContentTypes": { "type": "object", @@ -43208,8 +43793,7 @@ }, "description": "Template locked fields" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParameters": { "required": [ @@ -43233,8 +43817,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateParametersRoot": { "required": [ @@ -43246,8 +43829,7 @@ "$ref": "#/components/schemas/LinkedPATemplateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummary": { "type": "object", @@ -43268,8 +43850,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplatePostSummaryRoot": { "required": [ @@ -43281,8 +43862,7 @@ "$ref": "#/components/schemas/LinkedPATemplatePostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummary": { "type": "object", @@ -43299,8 +43879,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateSummaryRoot": { "required": [ @@ -43315,8 +43894,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParameters": { "type": "object", @@ -43332,8 +43910,7 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "additionalProperties": false + } }, "LinkedPATemplateUpdateParametersRoot": { "required": [ @@ -43345,8 +43922,7 @@ "$ref": "#/components/schemas/LinkedPATemplateUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "LinkedPATemplate": { "type": "object", @@ -43378,8 +43954,7 @@ "type": "string", "description": "Template parent tile." } - }, - "additionalProperties": false + } }, "LinkedPATemplateRoot": { "required": [ @@ -43391,8 +43966,7 @@ "$ref": "#/components/schemas/LinkedPATemplate" }, "meta": { } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategyOverrides": { "type": "object", @@ -43421,8 +43995,7 @@ "type": "string", "description": "Alpha" } - }, - "additionalProperties": false + } }, "NPOOptimizerStrategy": { "required": [ @@ -43437,8 +44010,7 @@ "type": "string", "description": "OptimizerStrategy document path" } - }, - "additionalProperties": false + } }, "NPOOptimizationParameters": { "required": [ @@ -43459,8 +44031,7 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "additionalProperties": false + } }, "NPOOptimizationParametersRoot": { "type": "object", @@ -43471,8 +44042,7 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "additionalProperties": false + } }, "PACalculationGroup": { "type": "object", @@ -43485,8 +44055,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "PACalculationColumn": { "type": "object", @@ -43502,8 +44071,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "PACalculationPricingSource": { "type": "object", @@ -43512,8 +44080,7 @@ "type": "string", "description": "Pricing source identifier" } - }, - "additionalProperties": false + } }, "PACalculationDataSources": { "type": "object", @@ -43536,8 +44103,7 @@ "type": "boolean", "description": "Use portfolio pricing sources for benchmark" } - }, - "additionalProperties": false + } }, "PACalculationParameters": { "required": [ @@ -43591,8 +44157,7 @@ "type": "string", "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "PACalculationParametersRoot": { "type": "object", @@ -43607,8 +44172,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "CalculationUnitStatus": { "type": "object", @@ -43643,9 +44207,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 +44241,7 @@ }, "description": "Number of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationUnitStatusMeta": { "type": "object", @@ -43681,8 +44250,7 @@ "type": "string", "description": "The Info URL of the calculation." } - }, - "additionalProperties": false + } }, "CalculationStatusMeta": { "type": "object", @@ -43694,8 +44262,7 @@ }, "description": "Meta of calculation units in batch." } - }, - "additionalProperties": false + } }, "CalculationStatusRoot": { "required": [ @@ -43709,8 +44276,7 @@ "meta": { "$ref": "#/components/schemas/CalculationStatusMeta" } - }, - "additionalProperties": false + } }, "CalculationsSummary": { "type": "object", @@ -43740,8 +44306,7 @@ "description": "Last poll time of calculation.", "format": "date-time" } - }, - "additionalProperties": false + } }, "PaginationInfo": { "type": "object", @@ -43768,8 +44333,7 @@ "previousPage": { "type": "string" } - }, - "additionalProperties": false + } }, "PaginationMeta": { "type": "object", @@ -43777,8 +44341,7 @@ "pagination": { "$ref": "#/components/schemas/PaginationInfo" } - }, - "additionalProperties": false + } }, "CalculationsSummaryRoot": { "required": [ @@ -43792,8 +44355,7 @@ "meta": { "$ref": "#/components/schemas/PaginationMeta" } - }, - "additionalProperties": false + } }, "PAPricingSource": { "type": "object", @@ -43810,8 +44372,7 @@ "type": "string", "description": "Pricing source category" } - }, - "additionalProperties": false + } }, "PAPricingSourceRoot": { "required": [ @@ -43826,8 +44387,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "PubIdentifier": { "required": [ @@ -43843,8 +44403,7 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - }, - "additionalProperties": false + } }, "PubDateParameters": { "required": [ @@ -43861,7 +44420,6 @@ "description": "Calculation's end date or as of date." } }, - "additionalProperties": false, "description": "The date parameters for Publisher calculation." }, "PubCalculationParameters": { @@ -43882,12 +44440,10 @@ "dates": { "$ref": "#/components/schemas/PubDateParameters" } - }, - "additionalProperties": false + } }, "PubCalculationMeta": { - "type": "object", - "additionalProperties": false + "type": "object" }, "PubCalculationParametersRoot": { "type": "object", @@ -43902,8 +44458,7 @@ "meta": { "$ref": "#/components/schemas/PubCalculationMeta" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverse": { "required": [ @@ -43930,8 +44485,7 @@ "securityExpr": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverse": { "required": [ @@ -43958,8 +44512,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantUniverse": { "required": [ @@ -43975,8 +44528,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverse": { "required": [ @@ -43992,8 +44544,7 @@ "screen": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantDateList": { "type": "object", @@ -44009,8 +44560,7 @@ "type": "string" } } - }, - "additionalProperties": false + } }, "QuantDate": { "required": [ @@ -44036,8 +44586,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantFdsDate": { "required": [ @@ -44057,8 +44606,7 @@ "endDate": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpression": { "required": [ @@ -44084,8 +44632,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameter": { "required": [ @@ -44105,8 +44652,7 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParameters": { "type": "object", @@ -44114,8 +44660,7 @@ { "$ref": "#/components/schemas/QuantFormula" } - ], - "additionalProperties": false + ] }, "QuantFormula": { "required": [ @@ -44132,8 +44677,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpression": { "required": [ @@ -44156,8 +44700,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionUniverseObsolete": { "required": [ @@ -44187,8 +44730,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenUniverseObsolete": { "required": [ @@ -44207,8 +44749,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantIdentifierUniverseObsolete": { "required": [ @@ -44238,8 +44779,7 @@ ], "type": "string" } - }, - "additionalProperties": false + } }, "QuantFdsDateObsolete": { "required": [ @@ -44265,8 +44805,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantDateListObsolete": { "required": [ @@ -44290,8 +44829,7 @@ "overrideUniversalScreenCalendar": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantScreeningExpressionObsolete": { "required": [ @@ -44309,8 +44847,7 @@ "dateOffset": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantFqlExpressionObsolete": { "required": [ @@ -44331,8 +44868,7 @@ "isArrayReturnType": { "type": "boolean" } - }, - "additionalProperties": false + } }, "QuantUniversalScreenParameterObsolete": { "required": [ @@ -44347,12 +44883,10 @@ "name": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantAllUniversalScreenParametersObsolete": { - "type": "object", - "additionalProperties": false + "type": "object" }, "QuantCalculationParameters": { "type": "object", @@ -44426,8 +44960,7 @@ "jobDescription": { "type": "string" } - }, - "additionalProperties": false + } }, "QuantCalculationMeta": { "type": "object", @@ -44480,8 +45013,7 @@ "type": "string", "default": "JsonStach" } - }, - "additionalProperties": false + } }, "QuantCalculationParametersRoot": { "type": "object", @@ -44496,8 +45028,7 @@ "meta": { "$ref": "#/components/schemas/QuantCalculationMeta" } - }, - "additionalProperties": false + } }, "SPARDateParameters": { "required": [ @@ -44520,7 +45051,6 @@ "description": "Calculation's frequency." } }, - "additionalProperties": false, "description": "The date parameters for SPAR calculation." }, "SPARCalculationParameters": { @@ -44550,8 +45080,7 @@ "type": "string", "description": "Currency ISO code for calculation." } - }, - "additionalProperties": false + } }, "SPARCalculationParametersRoot": { "type": "object", @@ -44566,8 +45095,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } }, "PAComponentData": { "type": "object", @@ -44612,10 +45140,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 +45166,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentParametersRoot": { "required": [ @@ -44652,8 +45178,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummary": { "type": "object", @@ -44673,8 +45198,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentPostSummaryRoot": { "required": [ @@ -44686,8 +45210,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentPostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummary": { "type": "object", @@ -44704,8 +45227,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentSummaryRoot": { "required": [ @@ -44720,8 +45242,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParameters": { "type": "object", @@ -44737,8 +45258,7 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentUpdateParametersRoot": { "required": [ @@ -44750,8 +45270,7 @@ "$ref": "#/components/schemas/TemplatedPAComponentUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "TemplatedPAComponent": { "type": "object", @@ -44780,8 +45299,7 @@ "type": { "type": "string" } - }, - "additionalProperties": false + } }, "TemplatedPAComponentRoot": { "required": [ @@ -44793,8 +45311,7 @@ "$ref": "#/components/schemas/TemplatedPAComponent" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateParameters": { "required": [ @@ -44855,13 +45372,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 +45389,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummary": { "type": "object", @@ -44895,8 +45410,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplatePostSummaryRoot": { "required": [ @@ -44908,8 +45422,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplatePostSummary" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummary": { "type": "object", @@ -44926,8 +45439,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateSummaryRoot": { "required": [ @@ -44942,8 +45454,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateUpdateParameters": { "type": "object", @@ -44992,13 +45503,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 +45520,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParameters" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplate": { "type": "object", @@ -45072,7 +45581,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 +45598,7 @@ "type": "string", "description": "Unlinked template category" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateRoot": { "required": [ @@ -45102,8 +45610,7 @@ "$ref": "#/components/schemas/UnlinkedPATemplate" }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndType": { "type": "object", @@ -45116,8 +45623,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeRoot": { "required": [ @@ -45132,8 +45638,7 @@ } }, "meta": { } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateColumnDetails": { "type": "object", @@ -45153,8 +45658,7 @@ }, "description": "Column Statistic identifier" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateGroupDetails": { "type": "object", @@ -45171,8 +45675,7 @@ "type": "string", "description": "Grouping frequency" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetails": { "type": "object", @@ -45207,8 +45710,7 @@ "type": "string", "description": "Unlinked template type" } - }, - "additionalProperties": false + } }, "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { "required": [ @@ -45220,8 +45722,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": [ @@ -45249,8 +45779,7 @@ "type": "string", "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." } - }, - "additionalProperties": false + } }, "VaultCalculationParametersRoot": { "type": "object", @@ -45265,8 +45794,7 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - }, - "additionalProperties": false + } } }, "securitySchemes": {