diff --git a/openapi-schema-oneof-referenced-schema.json b/openapi-schema-oneof-referenced-schema.json index c1eccd7..48618ec 100644 --- a/openapi-schema-oneof-referenced-schema.json +++ b/openapi-schema-oneof-referenced-schema.json @@ -1,45385 +1,43466 @@ { - "openapi": "3.0.1", - "info": { - "title": "Engines API", - "description": "Allow clients to fetch Analytics through APIs.", - "contact": { - "name": "FactSet Research Systems", - "url": "https://developer.factset.com/contact", - "email": "api@factset.com" - }, - "license": { - "name": "Apache License, Version 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" + "openapi": "3.0.1", + "info": { + "title": "Engines API", + "description": "Allow clients to fetch Analytics through APIs.", + "contact": { + "name": "FactSet Research Systems", + "url": "https://developer.factset.com/contact", + "email": "api@factset.com" + }, + "license": { + "name": "Apache License, Version 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0" + }, + "version": "v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]" }, - "version": "v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]" - }, - "servers": [ - { - "url": "https://api.factset.com" - } - ], - "paths": { - "/analytics/engines/spar/v3/accounts/{accountPath}/returns-type": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get SPAR account returns type details", - "description": "This endpoint returns the returns type of account associated with SPAR", - "operationId": "getSPARReturnsType", - "parameters": [ - { - "name": "accountPath", - "in": "path", - "description": "URL encoded account path", - "required": true, - "schema": { - "type": "string", - "description": "URL encoded account path" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the list of return types for the account.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "servers": [ + { + "url": "https://api.factset.com" + } + ], + "paths": { + "/analytics/lookups/v3/accounts/{path}": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "Get accounts and sub-directories in a directory", + "description": "This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.", + "operationId": "getAccounts", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "The directory to get the accounts and sub-directories.", + "required": true, + "schema": { + "type": "string", + "description": "The directory to get the accounts and sub-directories.", + "default": "", + "example": "Client:" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of accounts 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AccountDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SPARAccountsRoot" + "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." + } } } - } - }, - "400": { - "description": "Invalid account.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "404": { - "description": "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" - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "AccountDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/afi/v3/optimizations": { + "post": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Create and Run AFI optimization", + "description": "This endpoint creates and runs AFI optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", + "operationId": "postAndOptimize", + "parameters": [ + { + "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": "Optimization Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/AFIOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } } - } - }, - "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." + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid optimization 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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } } - } - }, - "429": { - "description": "Rate limit reached. 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." + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/afi/v3/optimizations/{id}": { + "put": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Create or Update AFI optimization and run it.", + "description": "This endpoint updates and run the AFI optimization specified in the PUT body parameters. It also allows the creation of new AFI optimization with custom id.", + "operationId": "putAndOptimize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + } + }, + { + "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": "Optimization Parameters", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/AFIOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "SPARAccountsRoot" - } - ] - } - }, - "/analytics/lookups/v3/accounts/{path}": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get accounts and sub-directories in a directory", - "description": "This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.", - "operationId": "getAccounts", - "parameters": [ - { - "name": "path", - "in": "path", - "description": "The directory to get the accounts and sub-directories in", - "required": true, - "schema": { - "type": "string", - "description": "The directory to get the accounts and sub-directories in", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of accounts 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." + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid Optimization 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AccountDirectoriesRoot" - } - } - } - }, - "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." + "404": { + "description": "One or more optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate optimization exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Path not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "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" + }, + "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } } - } - }, - "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" + }, + "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." + } } - }, - "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.", + "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + }, + "get": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Get AFI optimization parameters by id", + "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", + "operationId": "getOptimizationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the AFI optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AFIOptimizationParametersRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "Optimization 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" + } } }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } } - } - }, - "503": { - "description": "Request timed out. Retry the request in some time", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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": "AccountDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/afi/v3/optimizations": { - "post": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Create and Run AFI optimization", - "description": "This endpoint creates and runs AFI optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", - "operationId": "postAndOptimize", - "parameters": [ - { - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "AFIOptimizationParametersRoot" } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + }, + "delete": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Cancel AFI optimization by id", + "description": "This is the endpoint to cancel a previously submitted optimization.", + "operationId": "cancelOptimizationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", + "required": true, "schema": { - "$ref": "#/components/schemas/AFIOptimizationParametersRoot" + "type": "string", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, optimization was canceled 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" + } + } } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "404": { + "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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/CalculationInfoRoot" + "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." + } } } } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/afi/v3/optimizations/{id}/status": { + "get": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Get AFI optimization status by id", + "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getOptimizationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once optimization is completed, returns 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "202": { + "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } } - } - }, - "400": { - "description": "Invalid optimization 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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "One or more optimization 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" + }, + "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } - } - }, - "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." + }, + "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." + } } } } }, - "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" - } - } + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null } - }, - "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" + ] + } + }, + "/analytics/engines/afi/v3/optimizations/{id}/result": { + "get": { + "tags": [ + "AFI Optimizer" + ], + "summary": "Get AFI optimization result by id", + "description": "This is the endpoint to get the result of a previously requested optimization.", + "operationId": "getOptimizationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once optimization is completed, returns JSON.", + "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" + } } }, - "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" + } } } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/afi/v3/optimizations/{id}": { - "put": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Create or Update AFI optimization and run it.", - "description": "This endpoint updates and run the AFI optimization specified in the PUT body parameters. It also allows the creation of new AFI optimization with custom id.", - "operationId": "putAndOptimize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" - } }, - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds.", - "schema": { - "type": "integer" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" } - }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts max-stale.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + } + }, + "/analytics/engines/axp/v3/optimizations": { + "post": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Create and Run Axioma optimization", + "description": "This endpoint creates and runs Axioma optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", + "operationId": "postAndOptimize", + "parameters": [ + { + "name": "X-FactSet-Api-Long-Running-Deadline", + "in": "header", + "description": "Long running deadline in seconds.", "schema": { - "$ref": "#/components/schemas/AFIOptimizationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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" - } + "type": "integer" } }, + { + "name": "Cache-Control", + "in": "header", + "description": "Standard HTTP header. Accepts max-stale.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Optimization Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" } } } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "400": { - "description": "Invalid Optimization Parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "400": { + "description": "Invalid optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "One or more optimization 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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "409": { - "description": "Duplicate optimization exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/axp/v3/optimizations/{id}": { + "put": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Create or Update Axioma optimization and run it.", + "description": "This endpoint updates and run the Axioma optimization specified in the PUT body parameters. It also allows the creation of new Axioma optimization with custom id.", + "operationId": "putAndOptimize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" + } + }, + { + "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": "Optimization Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } } - } - }, - "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" + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "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" + } } } - } - }, - "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" + }, + "400": { + "description": "Invalid Optimization 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" + } } }, - "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" + } } } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate optimization exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Get AFI optimization parameters by id", - "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", - "operationId": "getOptimizationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the AFI optimization 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." + ] + }, + "get": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Get Axioma optimization parameters by id", + "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", + "operationId": "getOptimizationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the Axioma optimization 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-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" + } } - }, - "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." + } + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "404": { + "description": "Optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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/AFIOptimizationParametersRoot" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "AxiomaEquityOptimizationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Cancel Axioma optimization by id", + "description": "This is the endpoint to cancel a previously submitted optimization.", + "operationId": "cancelOptimizationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, optimization was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Optimization 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" + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/axp/v3/optimizations/{id}/status": { + "get": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Get Axioma optimization status by id", + "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getOptimizationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once optimization is completed, returns 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } } - } - }, - "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." + }, + "202": { + "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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": "AFIOptimizationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Cancel AFI optimization by id", - "description": "This is the endpoint to cancel a previously submitted optimization.", - "operationId": "cancelOptimizationById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" + }, + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null } - } - ], - "responses": { - "204": { - "description": "Expected response, optimization was canceled 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" + ] + } + }, + "/analytics/engines/axp/v3/optimizations/{id}/result": { + "get": { + "tags": [ + "AXP Optimizer" + ], + "summary": "Get Axioma optimization result by id", + "description": "This is the endpoint to get the result of a previously requested optimization.", + "operationId": "getOptimizationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get Axioma optimization status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Axioma optimization status by id endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once optimization is completed, returns JSON.", + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } } } }, - "404": { - "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/bpm/v3/optimizations": { + "post": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Create and Run BPM optimization", + "description": "This endpoint creates and runs BPM optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", + "operationId": "postAndOptimize", + "parameters": [ + { + "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": "Optimization Parameters", "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/BPMOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "400": { + "description": "Invalid optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/afi/v3/optimizations/{id}/status": { - "get": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Get AFI optimization status by id", - "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getOptimizationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" - } - } - ], - "responses": { - "201": { - "description": "Expected response once optimization is completed, returns JSON.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } - }, - "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": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/bpm/v3/optimizations/{id}": { + "put": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Create or Update BPM optimization and run it.", + "description": "This endpoint updates and run the BPM optimization specified in the PUT body parameters. It also allows the creation of new BPM optimization with custom id.", + "operationId": "putAndOptimize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" + } + }, + { + "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": "Optimization Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$ref": "#/components/schemas/BPMOptimizationParametersRoot" } } } }, - "202": { - "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "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." + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid Optimization 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" + } } }, - "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 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." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate optimization exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + }, + "get": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Get BPM optimization parameters by id", + "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", + "operationId": "getOptimizationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the BPM optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BPMOptimizationParametersRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "Optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-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": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" }, - { - "status-code": "202", - "response-type": null - } - ] - } - }, - "/analytics/engines/afi/v3/optimizations/{id}/result": { - "get": { - "tags": [ - "AFI Optimizer" - ], - "summary": "Get AFI optimization result by id", - "description": "This is the endpoint to get the result of a previously requested optimization.", - "operationId": "getOptimizationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "BPMOptimizationParametersRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response once optimization is completed, returns JSON.", - "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." + ] + }, + "delete": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Cancel BPM optimization by id", + "description": "This is the endpoint to cancel a previously submitted optimization.", + "operationId": "cancelOptimizationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, optimization was canceled 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" + } } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." + } + }, + "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" + } } }, - "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." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "404": { + "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/bpm/v3/optimizations/{id}/status": { + "get": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Get BPM optimization status by id", + "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getOptimizationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once optimization is completed, returns 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "202": { + "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null + } + ] + } + }, + "/analytics/engines/bpm/v3/optimizations/{id}/result": { + "get": { + "tags": [ + "BPM Optimizer" + ], + "summary": "Get BPM optimization result by id", + "description": "This is the endpoint to get the result of a previously requested optimization.", + "operationId": "getOptimizationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get BPM optimization status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get BPM optimization status by id endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once optimization is completed, returns JSON.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/axp/v3/optimizations": { - "post": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Create and Run Axioma optimization", - "description": "This endpoint creates and runs Axioma optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", - "operationId": "postAndOptimize", - "parameters": [ - { - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + } + }, + "/analytics/engines/pa/v3/columns": { + "get": { + "tags": [ + "Columns" + ], + "summary": "Get PA columns", + "description": "This endpoint lists all the PA columns that can be applied to a calculation.", + "operationId": "getPAColumns", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Column name", "schema": { - "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" + "type": "string", + "description": "Column name", + "default": "", + "example": "Security Name" } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" + }, + { + "name": "category", + "in": "query", + "description": "Column category", + "schema": { + "type": "string", + "description": "Column category", + "default": "" + } + }, + { + "name": "directory", + "in": "query", + "description": "The directory to get the columns in", + "schema": { + "type": "string", + "description": "The directory to get the columns in", + "default": "", + "example": "Client" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of PA columns", + "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." + } + }, + "Age": { + "description": "Standard HTTP header. Header will specify the age of columns list cached response.", + "schema": { + "type": "integer", + "description": "Standard HTTP header. Header will specify the age of columns list cached response." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "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-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ColumnSummaryRoot" + } } - }, - "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." + } + }, + "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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "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." + } } } } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ColumnSummaryRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/columns/{id}": { + "get": { + "tags": [ + "Columns" + ], + "summary": "Get PA column settings", + "description": "This endpoint returns the default settings of a PA column.", + "operationId": "getPAColumnById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a column", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a column", + "example": "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns settings of a PA column.", + "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." + } + }, + "Age": { + "description": "Standard HTTP header. Header will specify the age of columns list cached response.", + "schema": { + "type": "integer", + "description": "Standard HTTP header. Header will specify the age of columns list cached response." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "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-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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ColumnRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid column 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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Column 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } - } - }, - "400": { - "description": "Invalid optimization 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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "One or more optimization settings were unavailable.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ColumnRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/columnstatistics": { + "get": { + "tags": [ + "ColumnStatistics" + ], + "summary": "Get PA column statistics", + "description": "This endpoint lists all the column statistics that can be applied to a PA column.", + "operationId": "getPAColumnStatistics", + "responses": { + "200": { + "description": "Expected response, returns a list of PA column statistics", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ColumnStatisticRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ColumnStatisticRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/components": { + "get": { + "tags": [ + "Components" + ], + "summary": "Get PA components", + "description": "This endpoint returns the list of PA components in a given PA document.", + "operationId": "getPAComponents", + "parameters": [ + { + "name": "document", + "in": "query", + "description": "Document Name", + "required": true, + "schema": { + "type": "string", + "description": "Document Name", + "example": "PA3_DOCUMENTS:DEFAULT" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of PA components.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ComponentSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid query parameter provided or Invalid PA document name.", + "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" + } } }, - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "Document 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + }, + "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." + }, + "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." + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/axp/v3/optimizations/{id}": { - "put": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Create or Update Axioma optimization and run it.", - "description": "This endpoint updates and run the Axioma optimization specified in the PUT body parameters. It also allows the creation of new Axioma optimization with custom id.", - "operationId": "putAndOptimize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" - } - }, - { - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ComponentSummaryRoot" } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + } + }, + "/analytics/engines/pa/v3/components/{id}": { + "get": { + "tags": [ + "Components" + ], + "summary": "Get PA component by id", + "description": "This endpoint returns the default settings of a PA component.", + "operationId": "getPAComponentById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a PA component", + "required": true, "schema": { - "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" + "type": "string", + "description": "Unique identifier for a PA component", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the default settings of a PA 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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PAComponentRoot" + } } - }, - "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." + } + }, + "400": { + "description": "Invalid PA 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "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." + } } } - } - }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } } }, - "400": { - "description": "Invalid Optimization Parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "PAComponentRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/components": { + "get": { + "tags": [ + "Components" + ], + "summary": "Get Vault components", + "description": "This endpoint returns the list of Vault components in a given Vault document.", + "operationId": "getVaultComponents", + "parameters": [ + { + "name": "document", + "in": "query", + "description": "Document Name", + "required": true, + "schema": { + "type": "string", + "description": "Document Name" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of Vault components.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ComponentSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid query parameter provided or invalid Vault document name.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Vault Document 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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "One or more optimization 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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "409": { - "description": "Duplicate optimization exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ComponentSummaryRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/components/{id}": { + "get": { + "tags": [ + "Components" + ], + "summary": "Get Vault component by id", + "description": "This endpoint returns the default settings of a Vault component.", + "operationId": "getVaultComponentById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a vault component", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a vault component" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the default settings of a Vault 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultComponentRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid Vault 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" + } } }, - "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" + } } } }, - "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." + "404": { + "description": "Vault 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultComponentRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "summary": "Get Vault configurations", + "description": "This endpoint returns all the Vault configurations saved in the provided account.", + "operationId": "getVaultConfigurations", + "parameters": [ + { + "name": "account", + "in": "query", + "description": "Required account query parameter to filter configurations for a specific account", + "required": true, + "schema": { + "type": "string", + "description": "Required account query parameter to filter configurations for a specific account" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a dictionary of Vault configurations.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" + } } } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "400": { + "description": "Invalid account.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Get Axioma optimization parameters by id", - "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", - "operationId": "getOptimizationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultConfigurationSummaryRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the Axioma optimization 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." + ] + } + }, + "/analytics/engines/vault/v3/configurations/{id}": { + "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", + "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" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns details for a Vault configuration.", + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultConfigurationRoot" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AxiomaEquityOptimizationParametersRoot" + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "Optimization 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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultConfigurationRoot" + } + ] + } + }, + "/analytics/lookups/v3/currencies": { + "get": { + "tags": [ + "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 a list of currencies.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyRoot" + } } } }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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" + }, + "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." + }, + "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." + } } - }, - "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." + } } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CurrencyRoot" } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "AxiomaEquityOptimizationParametersRoot" - } - ] + ] + } }, - "delete": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Cancel Axioma optimization by id", - "description": "This is the endpoint to cancel a previously submitted optimization.", - "operationId": "cancelOptimizationById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, optimization was canceled 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." + "/analytics/engines/pa/v3/dates": { + "get": { + "tags": [ + "Dates" + ], + "summary": "Convert PA dates to absolute format", + "description": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal.", + "operationId": "convertPADatesToAbsoluteFormat", + "parameters": [ + { + "name": "startdate", + "in": "query", + "description": "Start Date", + "schema": { + "type": "string", + "description": "Start Date", + "example": "-3AY" + } + }, + { + "name": "enddate", + "in": "query", + "description": "End Date", + "required": true, + "schema": { + "type": "string", + "description": "End Date", + "example": "-1AY" + } + }, + { + "name": "componentid", + "in": "query", + "description": "Component Id", + "required": true, + "schema": { + "type": "string", + "description": "Component Id", + "example": "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" + } + }, + { + "name": "account", + "in": "query", + "description": "Account ( Should be in Format - AccountName.ACCT )", + "required": true, + "schema": { + "type": "string", + "description": "Account ( Should be in Format - AccountName.ACCT )", + "example": "Account Name" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the converted dates in yyyymmdd format.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DateParametersSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } } } }, - "404": { - "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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": "DateParametersSummaryRoot" + } + ] + } + }, + "/analytics/engines/vault/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", + "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": "Vault Component Id", + "required": true, + "schema": { + "type": "string", + "description": "Vault Component Id" + } + }, + { + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DateParametersSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "404": { + "description": "vault 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" + } } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + }, + "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DateParametersSummaryRoot" + } + ] + } + }, + "/analytics/engines/fi/v3/discount-curves": { + "get": { + "tags": [ + "DiscountCurves" + ], + "summary": "Get Discount Curves", + "description": "This endpoint lists all the discount curves that can be applied to a FI calculation.", + "operationId": "getAllFIDiscountCurves", + "parameters": [ + { + "name": "currency", + "in": "query", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FIDiscountCurveInfoRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/axp/v3/optimizations/{id}/status": { - "get": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Get Axioma optimization status by id", - "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getOptimizationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" - } - } - ], - "responses": { - "201": { - "description": "Expected response once optimization is completed, returns 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" + }, + "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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" + } } } - } - }, - "202": { - "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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-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": "", + "example": "Client:" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of PA3 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/documents/{path}": { + "get": { + "tags": [ + "Documents" + ], + "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", + "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": { + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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 some time", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" }, - { - "status-code": "202", - "response-type": null - } - ] - } - }, - "/analytics/engines/axp/v3/optimizations/{id}/result": { - "get": { - "tags": [ - "AXP Optimizer" - ], - "summary": "Get Axioma optimization result by id", - "description": "This is the endpoint to get the result of a previously requested optimization.", - "operationId": "getOptimizationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get Axioma optimization status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Axioma optimization status by id endpoint" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response once optimization is completed, returns JSON.", - "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." + ] + } + }, + "/analytics/engines/pub/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", + "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": { + "200": { + "description": "Expected response, returns a list of Publisher 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-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "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." + } + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } - } - }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/fiab/v1/calculations": { + "post": { + "tags": [ + "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": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/FIABCalculationParameters" } } } }, - "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." + "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" + } } } - } - }, - "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." + }, + "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": { + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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.", + "schema": { + "type": "string" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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": { + "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" + } } - }, - "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 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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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": { + "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/FIABCalculationStatusSummary" + } + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/spar/v3/benchmarks": { - "get": { - "tags": [ - "Benchmarks" - ], - "summary": "Get SPAR benchmark details", - "description": "This endpoint returns the details of a given SPAR benchmark identifier.", - "operationId": "getSPARBenchmarkById", - "parameters": [ - { - "name": "id", - "in": "query", - "description": "Benchmark Identifier", - "required": true, - "schema": { - "type": "string", - "description": "Benchmark Identifier" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the list of prefix and return types for the benchmark.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SPARBenchmarkRoot" + "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." + } } } } }, - "400": { - "description": "Invalid benchmark identifier.", - "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FIABCalculationStatus" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "404": { - "description": "Benchmark identifier not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "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.", + "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": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/FICalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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", + "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" + } } } - } - }, - "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." + }, + "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-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" + } } - }, - "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." + } + }, + "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-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" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } } } - } - }, - "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." + }, + "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." + } + }, + "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-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-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-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "SPARBenchmarkRoot" - } - ] - } - }, - "/analytics/engines/bpm/v3/optimizations": { - "post": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Create and Run BPM optimization", - "description": "This endpoint creates and runs BPM optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", - "operationId": "postAndOptimize", - "parameters": [ - { - "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" + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + } + }, + "/analytics/engines/fi/v3/calculations/{id}": { + "put": { + "tags": [ + "FICalculations" + ], + "summary": "Create or Update FI calculation and run it.", + "description": "This endpoint updates and run the FI optimization specified in the PUT body parameters. It also allows the creation of new FI optimization with custom id.", + "operationId": "putAndCalculate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", + "required": true, "schema": { - "$ref": "#/components/schemas/BPMOptimizationParametersRoot" + "type": "string", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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" - } + }, + { + "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/CalculationInfoRoot" + "$ref": "#/components/schemas/FICalculationParametersRoot" } } } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "400": { - "description": "Invalid optimization 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." + "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-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-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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-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-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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "One or more optimization 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." + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "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" + } } } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } } - } - }, - "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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + }, + "get": { + "tags": [ + "FICalculations" + ], + "summary": "Get FI calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the FI 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FICalculationParametersRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Calculation 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" + } } }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "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": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/bpm/v3/optimizations/{id}": { - "put": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Create or Update BPM optimization and run it.", - "description": "This endpoint updates and run the BPM optimization specified in the PUT body parameters. It also allows the creation of new BPM optimization with custom id.", - "operationId": "putAndOptimize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" - } - }, - { - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "FICalculationParametersRoot" } - } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { + ] + }, + "delete": { + "tags": [ + "FICalculations" + ], + "summary": "Cancel FI calculation by id", + "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 FI calculation endpoint", + "required": true, "schema": { - "$ref": "#/components/schemas/BPMOptimizationParametersRoot" + "type": "string", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, calculation was canceled 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" + } + } } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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/CalculationInfoRoot" + "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." + } } } } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/fi/v3/calculations/{id}/status": { + "get": { + "tags": [ + "FICalculations" + ], + "summary": "Get FI 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 body of the response will contain the requested document in JSON.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getCalculationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "202": { + "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } } - } - }, - "400": { - "description": "Invalid Optimization 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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "One or more optimization 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" + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "409": { - "description": "Duplicate optimization exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null + } + ] + } + }, + "/analytics/engines/fi/v3/calculations/{id}/result": { + "get": { + "tags": [ + "FICalculations" + ], + "summary": "Get FI 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": "getCalculationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get FI calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get FI 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/fpo/v3/optimizations": { + "post": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Create and Run FPO optimization", + "description": "This endpoint runs FPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", + "operationId": "postAndOptimize", + "parameters": [ + { + "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": "Optimization Parameters", + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/FPOOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "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" + } } } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "400": { + "description": "Invalid optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "One or more optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Get BPM optimization parameters by id", - "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", - "operationId": "getOptimizationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the BPM optimization 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" - } + ] + } + }, + "/analytics/engines/fpo/v3/optimizations/{id}": { + "put": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Create or Update FPO optimization and run it.", + "description": "This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id.", + "operationId": "putAndOptimize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + } + }, + { + "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": "Optimization Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BPMOptimizationParametersRoot" + "$ref": "#/components/schemas/FPOOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Optimization id not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "400": { + "description": "Invalid Optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "One or more optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "409": { + "description": "Duplicate optimization exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + }, + "get": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Get FPO optimization parameters by id", + "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", + "operationId": "getOptimizationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the FPO optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FPOOptimizationParametersRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "BPMOptimizationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Cancel BPM optimization by id", - "description": "This is the endpoint to cancel a previously submitted optimization.", - "operationId": "cancelOptimizationById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, optimization was canceled successfully.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "Optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "FPOOptimizationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Cancel FPO optimization by id", + "description": "This is the endpoint to cancel a previously submitted optimization.", + "operationId": "cancelOptimizationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, optimization was canceled 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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "404": { + "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "404": { - "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/fpo/v3/optimizations/{id}/status": { + "get": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Get FPO optimization status by id", + "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getOptimizationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once optimization is completed, returns 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" + } } }, - "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" + } } } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "202": { + "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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" + } } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null + } + ] + } + }, + "/analytics/engines/fpo/v3/optimizations/{id}/result": { + "get": { + "tags": [ + "FPO Optimizer" + ], + "summary": "Get FPO optimization result by id", + "description": "This is the endpoint to get the result of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.", + "operationId": "getOptimizationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint" + } + }, + { + "name": "Accept", + "in": "header", + "description": "Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or *", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Expected response once optimization is completed, returns JSON.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/bpm/v3/optimizations/{id}/status": { - "get": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Get BPM optimization status by id", - "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getOptimizationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" - } - } - ], - "responses": { - "201": { - "description": "Expected response once optimization is completed, returns JSON.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } } }, - "202": { - "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "schema": { - "type": "string", - "description": "FactSet's progress header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/frequencies": { + "get": { + "tags": [ + "Frequencies" + ], + "summary": "Get PA frequencies", + "description": "This endpoint lists all the frequencies that can be applied to a PA calculation.", + "operationId": "getPAFrequencies", + "responses": { + "200": { + "description": "Expected response, returns a list of PA frequencies.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyRoot" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "FrequencyRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/frequencies": { + "get": { + "tags": [ + "Frequencies" + ], + "summary": "Get Vault frequencies", + "description": "This endpoint lists all the frequencies that can be applied to a Vault calculation.", + "operationId": "getVaultFrequencies", + "responses": { + "200": { + "description": "Expected response, returns a list of Vault frequencies.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyRoot" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "FrequencyRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/groups": { + "get": { + "tags": [ + "Groups" + ], + "summary": "Get PA groups", + "description": "This endpoint lists all the PA groups that can be applied to a PA calculation.", + "operationId": "getPAGroups", + "responses": { + "200": { + "description": "Expected response, returns a list of PA groups", + "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." + } + }, + "Age": { + "description": "Standard HTTP header. Header will specify the age of groupings list cached response.", + "schema": { + "type": "integer", + "description": "Standard HTTP header. Header will specify the age of groupings list cached response." + } + }, + "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-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" }, - { - "status-code": "202", - "response-type": null - } - ] - } - }, - "/analytics/engines/bpm/v3/optimizations/{id}/result": { - "get": { - "tags": [ - "BPM Optimizer" - ], - "summary": "Get BPM optimization result by id", - "description": "This is the endpoint to get the result of a previously requested optimization.", - "operationId": "getOptimizationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get BPM optimization status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get BPM optimization status by id endpoint" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "GroupRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response once optimization is completed, returns JSON.", - "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." + ] + } + }, + "/analytics/engines/pa/v3/grouping-frequencies": { + "get": { + "tags": [ + "Groups" + ], + "summary": "Get PA grouping frequencies", + "description": "This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation.", + "operationId": "getPAGroupingFrequencies", + "responses": { + "200": { + "description": "Expected response, returns a list of PA grouping frequencies", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyRoot" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "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." + } } } } }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "FrequencyRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/linked-templates": { + "post": { + "tags": [ + "LinkedPATemplates" + ], + "summary": "Create a linked PA template", + "description": "This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.", + "operationId": "createLinkedPATemplates", + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "FactSet's request key header." + "$ref": "#/components/schemas/LinkedPATemplateParametersRoot" } - }, - "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." + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Expected response, created a template linked to a PA3 tile.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "LinkedPATemplatePostSummaryRoot" + } + ] + }, + "get": { + "tags": [ + "LinkedPATemplates" + ], + "summary": "Get linked PA templates", + "description": "This endpoint returns the list of linked PA templates in given path.", + "operationId": "getLinkedPATemplates", + "parameters": [ + { + "name": "directory", + "in": "query", + "description": "Get linked PA templates in path.", + "schema": { + "type": "string", + "description": "Get linked PA templates in path.", + "example": "Personal:LinkedPATemplates/" + } + }, + { + "name": "documentDirectory", + "in": "query", + "description": "Get linked PA templates for documents in document path", + "schema": { + "type": "string", + "description": "Get linked PA templates for documents in document path" + } + }, + { + "name": "documentName", + "in": "query", + "description": "Get linked PA templates for documents by document name", + "schema": { + "type": "string", + "description": "Get linked PA templates for documents by document name" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of templates linked to PA3 tile.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkedPATemplateSummaryRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "404": { + "description": "Document 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/columns": { - "get": { - "tags": [ - "Columns" - ], - "summary": "Get PA columns", - "description": "This endpoint lists all the PA columns that can be applied to a calculation.", - "operationId": "getPAColumns", - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Column name", - "schema": { - "type": "string", - "description": "Column name", - "default": "" - } - }, - { - "name": "category", - "in": "query", - "description": "Column category", - "schema": { - "type": "string", - "description": "Column category", - "default": "" - } - }, - { - "name": "directory", - "in": "query", - "description": "The directory to get the columns in", - "schema": { - "type": "string", - "description": "The directory to get the columns in", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of PA columns", - "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." + }, + "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." + } } - }, - "Age": { - "description": "Standard HTTP header. Header will specify the age of columns list cached response.", - "schema": { - "type": "integer", - "description": "Standard HTTP header. Header will specify the age of columns list cached response." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnSummaryRoot" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "LinkedPATemplateSummaryRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/linked-templates/{id}": { + "put": { + "tags": [ + "LinkedPATemplates" + ], + "summary": "Update a linked PA template", + "description": "This endpoint allows the user to change the request body and description from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.", + "operationId": "updateLinkedPATemplates", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a linked PA template", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" } } - }, - "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.", + ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/LinkedPATemplateUpdateParametersRoot" } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Expected response, updated a template linked to a PA3 tile.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template or 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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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": "LinkedPATemplatePostSummaryRoot" } - } + ] }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ColumnSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/columns/{id}": { - "get": { - "tags": [ - "Columns" - ], - "summary": "Get PA column settings", - "description": "This endpoint returns the default settings of a PA column.", - "operationId": "getPAColumnById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a column", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a column" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns settings of a PA column.", - "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." + "delete": { + "tags": [ + "LinkedPATemplates" + ], + "summary": "Delete a linked PA template.", + "description": "This endpoint deletes an existing linked PA template.", + "operationId": "deleteLinkedPATemplates", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a linked PA template", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" + } + } + ], + "responses": { + "204": { + "description": "Expected response, deleted the linked PA template 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" + } } - }, - "Age": { - "description": "Standard HTTP header. Header will specify the age of columns list cached response.", - "schema": { - "type": "integer", - "description": "Standard HTTP header. Header will specify the age of columns list cached response." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnRoot" + "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." + } } } - } - }, - "400": { - "description": "Invalid column 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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "Column not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + }, + "get": { + "tags": [ + "LinkedPATemplates" + ], + "summary": "Get linked PA template by id", + "description": "This endpoint fetches the linked PA template settings.", + "operationId": "getLinkedPATemplatesById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a linked PA template", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a linked PA template", + "example": "01234567890123456789012345678901" + } + } + ], + "responses": { + "200": { + "description": "Expected response, linked PA template details.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LinkedPATemplateRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "LinkedPATemplateRoot" + } + ] + } + }, + "/analytics/engines/npo/v3/optimizations": { + "post": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Create and Run NPO optimization", + "description": "This endpoint creates and runs NPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", + "operationId": "postAndOptimize", + "parameters": [ + { + "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": "Optimization Parameters", + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/NPOOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } + } + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } } - } - }, - "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." + }, + "400": { + "description": "Invalid optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ColumnRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/columnstatistics": { - "get": { - "tags": [ - "ColumnStatistics" - ], - "summary": "Get PA column statistics", - "description": "This endpoint lists all the column statistics that can be applied to a PA column.", - "operationId": "getPAColumnStatistics", - "responses": { - "200": { - "description": "Expected response, returns a list of PA column statistics", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnStatisticRoot" + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/npo/v3/optimizations/{id}": { + "put": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Create or Update NPO optimization and run it.", + "description": "This endpoint updates and run the NPO optimization specified in the PUT body parameters. It also allows the creation of new NPO optimization with custom id.", + "operationId": "putAndOptimize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" + } + }, + { + "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": "Optimization Parameters", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/NPOOptimizationParametersRoot" } } } }, - "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." + "responses": { + "202": { + "description": "Expected response, contains the poll URL in the Location header.", + "headers": { + "Location": { + "description": "URL to poll for the resulting optimization", + "schema": { + "type": "string", + "description": "URL to poll for the resulting optimization" + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationInfoRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "201": { + "description": "Expected response, returns json if optimization is completed in a short span.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + } + } + }, + "400": { + "description": "Invalid Optimization 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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "One or more optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate optimization exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } } } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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." + } } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationInfoRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } - } + ] }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ColumnStatisticRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/components": { - "get": { - "tags": [ - "Components" - ], - "summary": "Get PA components", - "description": "This endpoint returns the list of PA components in a given PA document.", - "operationId": "getPAComponents", - "parameters": [ - { - "name": "document", - "in": "query", - "description": "Document Name", - "required": true, - "schema": { - "type": "string", - "description": "Document Name" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of PA components.", - "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." + "get": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Get NPO optimization parameters by id", + "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", + "operationId": "getOptimizationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the NPO optimization 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NPOOptimizationParametersRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ComponentSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid query parameter provided or Invalid PA document name.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "404": { + "description": "Optimization 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "Document not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "NPOOptimizationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Cancel NPO optimization by id", + "description": "This is the endpoint to cancel a previously submitted optimization.", + "operationId": "cancelOptimizationById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, optimization was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "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" + } } } - } - }, - "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" + }, + "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." + } } - }, - "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.", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/npo/v3/optimizations/{id}/status": { + "get": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Get NPO optimization status by id", + "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getOptimizationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" + } + } + ], + "responses": { + "201": { + "description": "Expected response once optimization is completed, returns 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "202": { + "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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": "ComponentSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/components/{id}": { - "get": { - "tags": [ - "Components" - ], - "summary": "Get PA component by id", - "description": "This endpoint returns the default settings of a PA component.", - "operationId": "getPAComponentById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a PA component", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a PA component" + }, + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "202", + "response-type": null } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the default settings of a PA 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." + ] + } + }, + "/analytics/engines/npo/v3/optimizations/{id}/result": { + "get": { + "tags": [ + "NPO Optimizer" + ], + "summary": "Get NPO optimization result by id", + "description": "This is the endpoint to get the result of a previously requested optimization.", + "operationId": "getOptimizationResult", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once optimization is completed, returns JSON.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PAComponentRoot" - } - } - } - }, - "400": { - "description": "Invalid PA component id.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "404": { + "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "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" - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/calculations": { + "post": { + "tags": [ + "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.", + "operationId": "postAndCalculate", + "parameters": [ + { + "name": "X-FactSet-Api-Long-Running-Deadline", + "in": "header", + "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "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/ClientErrorResponse" + "$ref": "#/components/schemas/PACalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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" + }, + "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" + } } }, - "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" + } } } - } - }, - "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" + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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-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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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-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" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "PAComponentRoot" - } - ] - } - }, - "/analytics/engines/spar/v3/components": { - "get": { - "tags": [ - "Components" - ], - "summary": "Get SPAR components", - "description": "This endpoint returns the list of SPAR components in a given SPAR document.", - "operationId": "getSPARComponents", - "parameters": [ - { - "name": "document", - "in": "query", - "description": "Document Name", - "required": true, - "schema": { - "type": "string", - "description": "Document Name" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of SPAR components.", - "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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ComponentSummaryRoot" + "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." + } } } } }, - "400": { - "description": "Invalid query parameter provided or Invalid SPAR document name.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + } + ] + }, + "get": { + "tags": [ + "PACalculations" + ], + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationsSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid page number.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "No calculation 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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "SPAR Document not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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": "CalculationsSummaryRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/calculations/{id}": { + "put": { + "tags": [ + "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.", + "operationId": "putAndCalculate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run PA 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/ClientErrorResponse" + "$ref": "#/components/schemas/PACalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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-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-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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } } } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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." + } } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } - } + ] }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ComponentSummaryRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/components": { - "get": { - "tags": [ - "Components" - ], - "summary": "Get Vault components", - "description": "This endpoint returns the list of Vault components in a given Vault document.", - "operationId": "getVaultComponents", - "parameters": [ - { - "name": "document", - "in": "query", - "description": "Document Name", - "required": true, - "schema": { - "type": "string", - "description": "Document Name" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of Vault components.", - "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." + "get": { + "tags": [ + "PACalculations" + ], + "summary": "Get PA calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the PA 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PACalculationParametersRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ComponentSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid query parameter provided or invalid Vault document name.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "404": { + "description": "Calculation 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "Vault Document not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "PACalculationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "PACalculations" + ], + "summary": "Cancel PA calculation by id", + "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 PA calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, calculation was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/pa/v3/calculations/{id}/status": { + "get": { + "tags": [ + "PACalculations" + ], + "summary": "Get PA 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.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getCalculationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once calculation is completed.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "202": { + "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + } + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } } }, - "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." + "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/pa/v3/calculations/{id}/units/{unitId}/result": { + "get": { + "tags": [ + "PACalculations" + ], + "summary": "Get PA 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 PA calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get PA calculation status by id endpoint" + } + }, + { + "name": "unitId", + "in": "path", + "description": "from url, provided from the location header in the Get PA calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get PA 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" + } } }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ComponentSummaryRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/components/{id}": { - "get": { - "tags": [ - "Components" - ], - "summary": "Get Vault component by id", - "description": "This endpoint returns the default settings of a Vault component.", - "operationId": "getVaultComponentById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a vault component", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a vault component" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the default settings of a Vault 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" + }, + "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-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VaultComponentRoot" + "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." + } } } } }, - "400": { - "description": "Invalid Vault component id.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/pricing-sources": { + "get": { + "tags": [ + "PricingSources" + ], + "summary": "Get PA pricing sources", + "description": "This endpoint lists all the PA pricing sources that can be applied to a PA calculation.", + "operationId": "getPAPricingSources", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "PA pricing sources name", + "schema": { + "type": "string", + "description": "PA pricing sources name", + "default": "" + } + }, + { + "name": "category", + "in": "query", + "description": "PA pricing sources category", + "schema": { + "type": "string", + "description": "PA pricing sources category", + "default": "" + } + }, + { + "name": "directory", + "in": "query", + "description": "The directory to get the PA pricing sources in", + "schema": { + "type": "string", + "description": "The directory to get the PA pricing sources in", + "default": "" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of PA pricing sources", + "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." + } + }, + "Age": { + "description": "Standard HTTP header. Header will specify the age of pricing sources list cached response.", + "schema": { + "type": "integer", + "description": "Standard HTTP header. Header will specify the age of pricing sources list cached response." + } + }, + "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-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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PAPricingSourceRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Pricing sources 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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Vault Component not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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": "PAPricingSourceRoot" + } + ] + } + }, + "/analytics/engines/pub/v3/calculations": { + "post": { + "tags": [ + "PubCalculations" + ], + "summary": "Create and Run Pub calculation", + "description": "This endpoint runs the Pub calculation specified in the POST body parameters.\r\nIt can take one or more units as input.", + "operationId": "postAndCalculate", + "parameters": [ + { + "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.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Calculation Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/PubCalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "type": "string", + "format": "binary" + } } } - } - }, - "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." + }, + "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-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-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." + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "429": { + "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" + } } } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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." + } } } } }, - "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-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": null, + "is-file": true + } + ] + }, + "get": { + "tags": [ + "PubCalculations" + ], + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationsSummaryRoot" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "VaultComponentRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/configurations": { - "get": { - "tags": [ - "Configurations" - ], - "summary": "Get Vault configurations", - "description": "This endpoint returns all the Vault configurations saved in the provided account.", - "operationId": "getVaultConfigurations", - "parameters": [ - { - "name": "account", - "in": "query", - "description": "Required account query parameter to filter configurations for a specific account", - "required": true, - "schema": { - "type": "string", - "description": "Required account query parameter to filter configurations for a specific account" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a dictionary of Vault configurations.", - "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." + }, + "400": { + "description": "Invalid page number.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "No calculation 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VaultConfigurationSummaryRoot" + "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." + } } } - } - }, - "400": { - "description": "Invalid account.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "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" - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CalculationsSummaryRoot" + } + ] + } + }, + "/analytics/engines/pub/v3/calculations/{id}": { + "put": { + "tags": [ + "PubCalculations" + ], + "summary": "Create or Update Pub calculation and run it.", + "description": "This endpoint updates and run the Pub calculation specified in the PUT body parameters. This also allows creating new Pub calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", + "operationId": "putAndCalculate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Pub 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/ClientErrorResponse" + "$ref": "#/components/schemas/PubCalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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." + }, + "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-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" + } } }, - "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." + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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-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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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-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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "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-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" + } + }, + "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." + }, + "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." + } + }, + "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-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-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." + } } } } }, - "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-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": null, + "is-file": true + } + ] + }, + "get": { + "tags": [ + "PubCalculations" + ], + "summary": "Get Pub calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the Pub 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PubCalculationParametersRoot" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "VaultConfigurationSummaryRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/configurations/{id}": { - "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", - "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" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns details for a Vault configuration.", - "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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Calculation 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VaultConfigurationRoot" + "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." + } } } - } - }, - "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" + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "PubCalculationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "PubCalculations" + ], + "summary": "Cancel Pub calculation by id", + "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 Pub calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, calculation was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/pub/v3/calculations/{id}/status": { + "get": { + "tags": [ + "PubCalculations" + ], + "summary": "Get Pub 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", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once calculation is completed.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + } + ] + } + }, + "/analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result": { + "get": { + "tags": [ + "PubCalculations" + ], + "summary": "Get Pub 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 the specified format.", + "operationId": "getCalculationUnitResultById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" + } + }, + { + "name": "unitId", + "in": "path", + "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once calculation is completed, returns result in the format specified in the Calculation parameters.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/x-protobuf": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/pdf": { + "schema": { + "type": "string", + "format": "binary" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "VaultConfigurationRoot" - } - ] - } - }, - "/analytics/lookups/v3/currencies": { - "get": { - "tags": [ - "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 a list of currencies.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/pdf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyRoot" + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": null, + "is-file": true + } + ] + } + }, + "/analytics/engines/quant/v3/calculations": { + "post": { + "tags": [ + "QuantCalculations" + ], + "summary": "Create and Run Quant Engine calculation", + "description": "This endpoint runs the Quant Engine calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input.", + "operationId": "postAndCalculate", + "parameters": [ + { + "name": "Cache-Control", + "in": "header", + "description": "Standard HTTP header. Accepts no-store, max-age, max-stale.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/QuantCalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/octet-stream": { + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/x-protobuf": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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-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-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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.", + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "500": { + "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + } + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "CurrencyRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/dates": { - "get": { - "tags": [ - "Dates" - ], - "summary": "Convert PA dates to absolute format", - "description": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal.", - "operationId": "convertPADatesToAbsoluteFormat", - "parameters": [ - { - "name": "startdate", - "in": "query", - "description": "Start Date", - "schema": { - "type": "string", - "description": "Start Date" - } - }, - { - "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" + "x-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + }, + { + "status-code": "200", + "response-type": "CalculationStatusRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the converted dates in yyyymmdd format.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + ] + }, + "get": { + "tags": [ + "QuantCalculations" + ], + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationsSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Invalid page number.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "No calculation 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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DateParametersSummaryRoot" + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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": "CalculationsSummaryRoot" + } + ] + } + }, + "/analytics/engines/quant/v3/calculations/{id}": { + "put": { + "tags": [ + "QuantCalculations" + ], + "summary": "Create or update Quant Engine calculation and run it.", + "description": "This endpoint updates and runs the Quant Engine calculation specified in the PUT body parameters. This also allows creating new Quant Engine calculations with custom ids.\r\nIt can take one or more calculation units as input.", + "operationId": "putAndCalculate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" + } }, + { + "name": "Cache-Control", + "in": "header", + "description": "Standard HTTP header. Accepts no-store, max-age, max-stale.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Calculation Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/QuantCalculationParametersRoot" } } } }, - "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" + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } } - } - }, - "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." + }, + "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-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-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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } } - } - }, - "429": { - "description": "Rate limit reached. 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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": true, + "x-success-response-types": [ + { + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" + } + ] + }, + "get": { + "tags": [ + "QuantCalculations" + ], + "summary": "Get Quant Engine calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the Quant Engine calculation parameters.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuantCalculationParametersRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "DateParametersSummaryRoot" - } - ] - } - }, - "/analytics/engines/vault/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", - "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": "Vault Component Id", - "required": true, - "schema": { - "type": "string", - "description": "Vault Component Id" - } - }, - { - "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.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "404": { + "description": "Calculation 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DateParametersSummaryRoot" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "QuantCalculationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "QuantCalculations" + ], + "summary": "Cancel Quant calculation by id", + "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 Quant calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Quant calculation endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, calculation was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "vault 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" + }, + "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } - } - }, - "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." + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/quant/v3/calculations/{id}/status": { + "get": { + "tags": [ + "QuantCalculations" + ], + "summary": "Get Quant Engine 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.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", + "operationId": "getCalculationStatusById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once calculation is completed.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "202": { + "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", + "headers": { + "X-FactSet-Api-PickUp-Progress": { + "description": "FactSet's progress header.", + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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-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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/x-protobuf": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "DateParametersSummaryRoot" - } - ] - } - }, - "/analytics/engines/fi/v3/discount-curves": { - "get": { - "tags": [ - "DiscountCurves" - ], - "summary": "Get Discount Curves", - "description": "This endpoint lists all the discount curves that can be applied to a FI calculation.", - "operationId": "getAllFIDiscountCurves", - "parameters": [ - { - "name": "currency", - "in": "query", - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIDiscountCurveInfoRoot" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": null, + "is-file": true + } + ] + } + }, + "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info": { + "get": { + "tags": [ + "QuantCalculations" + ], + "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 calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "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 calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/x-protobuf": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "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" + } + } + } + }, + "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" + } } }, - "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" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } } - } - }, - "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" + }, + "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-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", + } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": null, + "is-file": true + } + ] + } + }, + "/analytics/security-modeling/v3/securities/retrieve": { + "post": { + "tags": [ + "SecurityModeling" + ], + "summary": "Get existing securities", + "description": "This endpoint gets all existing securities.", + "operationId": "getSecurities", + "requestBody": { + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/SMRetrieveParametersRoot" } } } }, - "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." + "responses": { + "200": { + "description": "Expected response, returns a list of existing securities.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SMRetrieveResponseRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "SMRetrieveResponseRoot" + } + ] + } + }, + "/analytics/security-modeling/v3/securities/upsert": { + "post": { + "tags": [ + "SecurityModeling" + ], + "summary": "Create or update securities", + "description": "This endpoint is to create or update existing securities.", + "operationId": "upsertSecurities", + "requestBody": { + "content": { + "application/json": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/SMCreateParametersRoot" } } } }, - "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." + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SMCreateResponseRoot" + } } } - } - } - }, - "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", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "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." + } } } } }, - "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" - } - } - }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "SMCreateResponseRoot" + } + ] + } + }, + "/analytics/security-modeling/v3/securities/delete": { + "post": { + "tags": [ + "SecurityModeling" + ], + "summary": "Delete existing securities", + "description": "This endpoint deletes existing securities.", + "operationId": "deleteSecurities", + "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/SMDeleteParametersRoot" } } } }, - "404": { - "description": "Path not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "responses": { + "200": { + "description": "Expected response, deletes existing securities.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SMDeleteResponseRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "SMDeleteResponseRoot" + } + ] + } + }, + "/analytics/security-modeling/v3/templates/{template}/fields": { + "get": { + "tags": [ + "SecurityModeling" + ], + "summary": "Get template fields", + "description": "This endpoint gets template fields.", + "operationId": "getTemplateFields", + "parameters": [ + { + "name": "template", + "in": "path", + "description": "Template name", + "required": true, + "schema": { + "type": "string", + "description": "Template name" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of all template fields.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SMTemplateFieldPropertiesRoot" + } } } - } - }, - "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." + }, + "400": { + "description": "Invalid 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "503": { - "description": "Request timed out. Retry the request in some time", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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." + } } - }, - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/documents/{path}": { - "get": { - "tags": [ - "Documents" - ], - "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", - "in": "path", - "description": "The directory to get the documents in", - "required": true, - "schema": { - "type": "string", - "description": "The directory to get the documents in", - "default": "" + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "SMTemplateFieldPropertiesRoot" } - } - ], - "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." + ] + } + }, + "/analytics/engines/axp/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", + "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": "" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of Axioma Equity strategy 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "404": { - "description": "Path not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/afi/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", + "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": "" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of Axioma FI strategy 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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 some time", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/bpm/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", + "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": "" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of Barra strategy 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "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." + } } } - } - }, - "503": { - "description": "Request timed out. Retry the request in some time", - "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" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/spar/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", - "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": { - "200": { - "description": "Expected response, returns a list of SPAR3 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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/npo/v3/strategies/{path}": { + "get": { + "tags": [ + "StrategyDocuments" + ], + "summary": "Get Northfield strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all Northfield strategy documents and sub-directories in a given directory.", + "operationId": "getNorthfieldStrategyDocuments", + "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": "" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of Northfield strategy 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Path not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "503": { + "description": "Request timed out. Retry the request in some time", + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/fpo/v3/strategies/{path}": { + "get": { + "tags": [ + "StrategyDocuments" + ], + "summary": "Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory", + "description": "This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory.", + "operationId": "getFPOStrategyDocuments", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "The directory to get the strategy documents and sub-directories in", + "required": true, + "schema": { + "type": "string", + "description": "The directory to get the strategy documents and sub-directories in", + "default": "" + } + } + ], + "responses": { + "200": { + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentDirectoriesRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Path not found", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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 some time", + "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "DocumentDirectoriesRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/templated-components": { + "post": { + "tags": [ + "TemplatedPAComponents" + ], + "summary": "Create templated PA component", + "description": "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "createTemplatedPAComponents", + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/TemplatedPAComponentParametersRoot" } } - } + }, + "required": true }, - "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." + "responses": { + "201": { + "description": "Expected response, templated PA component created 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" + } } }, - "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." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } } } - } - }, - "503": { - "description": "Request timed out. Retry the request in some time", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/pub/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", - "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": { - "200": { - "description": "Expected response, returns a list of Publisher documents and directories", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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-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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentDirectoriesRoot" + "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." + } } } } }, - "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-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", + "example": "Personal:TemplatedPAComponents/" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list templated PA components.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "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." + } } } - } - }, - "404": { - "description": "Path not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "TemplatedPAComponentSummaryRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/templated-components/{id}": { + "put": { + "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", + "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", + "example": "01234567890123456789012345678901" } } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", + ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "FactSet's request key header." + "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" } - }, - "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." + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Expected response, updated 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "404": { + "description": "Component or template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + } + }, + "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." + } } } } }, - "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-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", + "example": "01234567890123456789012345678901" + } + } + ], + "responses": { + "200": { + "description": "Expected response, templated PA component details.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentRoot" + } } } - } - }, - "503": { - "description": "Request timed out. Retry the request in some time", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/fiab/v1/calculations": { - "post": { - "tags": [ - "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": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIABCalculationParameters" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the URL in the Location header to check the status of the calculation.", - "headers": { - "Location": { - "description": "URL to check status of the request.", - "schema": { - "type": "string", - "description": "URL to check status of the request." + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "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 FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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": { - "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": "TemplatedPAComponentRoot" + } + ] + }, + "delete": { + "tags": [ + "TemplatedPAComponents" + ], + "summary": "Delete templated PA component", + "description": "This endpoint deletes an existing templated PA component", + "operationId": "deleteTemplatedPAComponents", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique identifier for a templated PA component", + "required": true, + "schema": { + "type": "string", + "description": "Unique identifier for a templated PA component", + "example": "01234567890123456789012345678901" + } + } + ], + "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" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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" + } } }, - "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." + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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." + } } - }, - "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": { + "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": { - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/pa/v3/unlinked-templates": { + "post": { + "tags": [ + "UnlinkedPATemplates" + ], + "summary": "Create unlinked PA template", + "description": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also \r\n overriding the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", + "operationId": "createUnlinkedPATemplates", + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } - } - }, - "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." + }, + "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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "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 FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "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." + } } } } }, - "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-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.", + "example": "Personal:UninkedPATemplates/" + } + }, + { + "name": "category", + "in": "query", + "description": "Get unlinked PA templates by category.", + "schema": { + "type": "string", + "description": "Get unlinked PA templates by category.", + "example": "Weights" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns a list of unlinked PA templates.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } - }, - "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.", + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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." + } } - }, - "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": { + "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": { - "Location": { - "description": "URL to check status of the request.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "UnlinkedPATemplateSummaryRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/unlinked-templates/{id}": { + "put": { + "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", + "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", + "example": "01234567890123456789012345678901" + } + } + ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { "schema": { - "type": "string", - "description": "URL to check status of the request." + "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Expected response, updated 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FIAB request limit.", - "schema": { - "type": "string", - "description": "Maximum FIAB request limit." + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - } - }, - "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." + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/FIABCalculationStatusSummary" + "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" } } } - } - }, - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "UnlinkedPATemplatePostSummaryRoot" + } + ] + }, + "delete": { + "tags": [ + "UnlinkedPATemplates" + ], + "summary": "Delete unlinked PA template", + "description": "This endpoint deletes an existing unliked PA template.", + "operationId": "deleteUnlinkedPATemplates", + "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", + "example": "01234567890123456789012345678901" + } + } + ], + "responses": { + "204": { + "description": "Expected response, deleted the unlinked PA template 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" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "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." + }, + "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." + } } - }, - "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." + } } } } }, - "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": "204", + "response-type": null } - } + ] }, - "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." + "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", + "example": "01234567890123456789012345678901" + } + } + ], + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateRoot" + } } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "404": { + "description": "Template not found.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIABCalculationStatus" + "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." + } } } - } - }, - "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." + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIABCalculationStatus" + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "UnlinkedPATemplateRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/unlinked-templates/template-types": { + "get": { + "tags": [ + "UnlinkedPATemplates" + ], + "summary": "Get default unlinked PA template types.", + "description": "This endpoint fetches default unlinked PA template types.", + "operationId": "getDefaultUnlinkedPATemplateTypes", + "responses": { + "200": { + "description": "Expected response, default unlinked PA template types", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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." + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "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" + } } } - } - }, - "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." + }, + "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" + } } - }, - "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." + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "UnlinkedPATemplateCategoryAndTypeRoot" + } + ] + } + }, + "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}": { + "get": { + "tags": [ + "UnlinkedPATemplates" + ], + "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, details of the unlinked PA template type", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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": "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." + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } } - } - }, - "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." + }, + "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." + } } - }, - "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" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" } - } - ], - "requestBody": { - "description": "Calculation Parameters", - "content": { - "application/json": { + ] + } + }, + "/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": { - "$ref": "#/components/schemas/FICalculationParametersRoot" + "type": "string" } } - } - }, - "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.", + ], + "requestBody": { + "content": { + "multipart/form-data": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "nullable": true + } + } + }, + "encoding": { + "file": { + "style": "form" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultAttributionLoaderResponseRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "400": { + "description": "Bad Request", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "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" + } } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + } + }, + "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" + } } } - } - }, - "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" + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } + } + }, + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultAttributionLoaderResponseRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/calculations": { + "post": { + "tags": [ + "VaultCalculations" + ], + "summary": "Create and Run Vault calculation", + "description": "This endpoint runs the Vault calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", + "operationId": "postAndCalculate", + "parameters": [ + { + "name": "X-FactSet-Api-Long-Running-Deadline", + "in": "header", + "description": "Long running deadline in seconds when only one unit is passed in the POST body.", + "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/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + "$ref": "#/components/schemas/VaultCalculationParametersRoot" } } } }, - "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." + "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" + } } }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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-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" + } } }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + }, + "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" + } } }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "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." + } + }, + "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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "415": { + "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } - }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } } } }, - "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-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": [ + "VaultCalculations" + ], + "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.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationsSummaryRoot" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + }, + "400": { + "description": "Invalid page number.", + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "404": { + "description": "No calculation 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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + }, + "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-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-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-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "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" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } - }, - "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." + } } } } }, - "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.", + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CalculationsSummaryRoot" + } + ] + } + }, + "/analytics/engines/vault/v3/calculations/{id}": { + "put": { + "tags": [ + "VaultCalculations" + ], + "summary": "Create or Update Vault calculation and run it.", + "description": "This endpoint updates and run the Vault calculation specified in the PUT body parameters. This also allows creating new Vault calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", + "operationId": "putAndCalculate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Vault 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": { - "type": "string", - "description": "FactSet's request key header." + "$ref": "#/components/schemas/VaultCalculationParametersRoot" } - }, - "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." + } + } + }, + "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" + } } }, - "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/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.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + } + }, + "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-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-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + } + }, + "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" + } } }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "409": { + "description": "Duplicate calculation exists with same parameters.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + }, + "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-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-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.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + }, + "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" + } } - }, - "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." + } + }, + "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" + } } - }, - "X-FactSet-Api-Calculations-Limit": { - "description": "Maximum FI request limit.", - "schema": { - "type": "string", - "description": "Maximum FI request limit." + } + }, + "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." + } } - }, - "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." + } + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/fi/v3/calculations/{id}": { - "put": { - "tags": [ - "FICalculations" - ], - "summary": "Create or Update FI calculation and run it.", - "description": "This endpoint updates and run the FI optimization specified in the PUT body parameters. It also allows the creation of new FI optimization with custom id.", - "operationId": "putAndCalculate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" - } - }, - { - "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" - } + "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" } - } + ] }, - "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" + "get": { + "tags": [ + "VaultCalculations" + ], + "summary": "Get Vault calculation parameters by id", + "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", + "operationId": "getCalculationParameters", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response, returns the Vault 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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VaultCalculationParametersRoot" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "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" + } } }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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." + }, + "404": { + "description": "Calculation 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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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." + } } - }, - "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", + "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" + "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." + } } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" + } + }, + "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." + } } } } }, - "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-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "VaultCalculationParametersRoot" + } + ] + }, + "delete": { + "tags": [ + "VaultCalculations" + ], + "summary": "Cancel Vault calculation by id", + "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 Vault calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" + } + } + ], + "responses": { + "204": { + "description": "Expected response, calculation was canceled 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" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + } + }, + "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.", + "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" + } } }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } }, - "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." + } } } - } - }, - "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" + }, + "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "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." + } } } } }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "204", + "response-type": null + } + ] + } + }, + "/analytics/engines/vault/v3/calculations/{id}/status": { + "get": { + "tags": [ + "VaultCalculations" + ], + "summary": "Get Vault 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", + "in": "path", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" + } + } + ], + "responses": { + "200": { + "description": "Expected response once calculation is completed.", + "headers": { + "Content-Encoding": { + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." + } + }, + "Content-Type": { + "description": "Standard HTTP header.", + "schema": { + "type": "string", + "description": "Standard HTTP header." + } + }, + "Transfer-Encoding": { + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", + "schema": { + "type": "string", + "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + } + }, + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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" + } } }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" + } } } - } - }, - "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." + }, + "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" + } } }, - "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." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } } - } - }, - "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" + }, + "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" + } } }, - "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": { - "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." + } } } - } - }, - "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" + }, + "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." + }, + "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." + }, + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "schema": { + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } } } } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "FICalculations" - ], - "summary": "Get FI calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "202", + "response-type": "CalculationStatusRoot" } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the FI 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." + ] + } + }, + "/analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result": { + "get": { + "tags": [ + "VaultCalculations" + ], + "summary": "Get Vault 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 Vault calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint" + } + }, + { + "name": "unitId", + "in": "path", + "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint", + "required": true, + "schema": { + "type": "string", + "description": "from url, provided from the location header in the Get Vault 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" + } } }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ObjectRoot" + } } - }, - "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." + } + }, + "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" + } } }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "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" + } } }, - "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" + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FICalculationParametersRoot" + "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." + } } } - } - }, - "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" + }, + "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" + } } - }, - "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." + } } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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." + } } } } }, - "404": { - "description": "Calculation id not found", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } + "x-are-multiple-success-responses-different": false, + "x-success-response-types": [ + { + "status-code": "200", + "response-type": "ObjectRoot" + } + ] + } + } + }, + "components": { + "schemas": { + "AccountDirectories": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "type": "string" }, - "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." - } + "description": "List of account and composite files." + }, + "directories": { + "type": "array", + "items": { + "type": "string" }, - "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" - } - } + "description": "List of directories." + } + } + }, + "AccountDirectoriesRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AccountDirectories" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "meta": { + "type": "object" } - }, - "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." - } - } + } + }, + "ErrorSource": { + "type": "object", + "properties": { + "pointer": { + "type": "string" + }, + "parameter": { + "type": "string" } - }, - "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" - } - } + } + }, + "Error": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ErrorSource" } - }, - "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." - } + } + }, + "ClientErrorResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" } } - }, - "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." - } + } + }, + "AFIOptimizerStrategyOverrides": { + "type": "object", + "properties": { + "objective": { + "type": "string", + "description": "Objective" + }, + "tax": { + "type": "string", + "description": "Tax" + }, + "constraints": { + "type": "object", + "additionalProperties": { + "enum": [ + "Disable", + "Enable" + ], + "type": "string" }, - "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." - } - } + "description": "List of constraints" + }, + "alpha": { + "type": "string", + "description": "Alpha" + }, + "transactionCost": { + "type": "string", + "description": "Transaction cost" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FICalculationParametersRoot" + "AFIOptimizerStrategy": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "overrides": { + "$ref": "#/components/schemas/AFIOptimizerStrategyOverrides" + }, + "id": { + "type": "string", + "description": "OptimizerStrategy document path" + } } - ] - }, - "delete": { - "tags": [ - "FICalculations" - ], - "summary": "Cancel FI calculation by id", - "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 FI calculation endpoint", - "required": true, - "schema": { + }, + "OptimizerAccountOverrides": { + "type": "object", + "properties": { + "portfolio": { + "type": "string", + "description": "Portfolio" + }, + "benchmark": { + "type": "string", + "description": "Benchmark" + }, + "riskModelId": { + "type": "string", + "description": "Risk model" + }, + "currency": { "type": "string", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + "description": "Currency" } } - ], - "responses": { - "204": { - "description": "Expected response, calculation was canceled 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" - } - } + }, + "OptimizerAccount": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Account path" + }, + "overrides": { + "$ref": "#/components/schemas/OptimizerAccountOverrides" } - }, - "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" - } - } + } + }, + "Optimization": { + "type": "object", + "properties": { + "riskModelDate": { + "type": "string", + "description": "Risk model date" }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "backtestDate": { + "type": "string", + "description": "Backtest date" + }, + "cashflow": { + "type": "string", + "description": "Cash flow" } - }, - "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.", - "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" - } - } + } + }, + "OptimizerTradesList": { + "type": "object", + "properties": { + "identifierType": { + "enum": [ + "Asset", + "Cusip", + "Isin", + "RiskModel", + "SedolChk", + "Sedol", + "SymbologyCusip", + "Ticker", + "TickerRegion", + "User" + ], + "type": "string", + "description": "Identifier type" }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "includeCash": { + "type": "boolean", + "description": "Include cash" } - }, - "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." - } - } + } + }, + "OptimizerOptimalHoldings": { + "type": "object", + "properties": { + "identifierType": { + "enum": [ + "Asset", + "Cusip", + "Isin", + "RiskModel", + "SedolChk", + "Sedol", + "SymbologyCusip", + "Ticker", + "TickerRegion", + "User" + ], + "type": "string", + "description": "Identifier type" + }, + "includeCash": { + "type": "boolean", + "description": "Include cash" + }, + "excludeZero": { + "type": "boolean", + "description": "Exclude zero" } - }, - "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" - } - } + } + }, + "OptimalPortfolio": { + "type": "object", + "properties": { + "acctName": { + "type": "string", + "description": "Account path" + }, + "excludeZero": { + "type": "boolean", + "description": "Exclude zero" + }, + "archiveDate": { + "type": "string", + "description": "Archive date" + }, + "ifAcctExists": { + "enum": [ + "abort", + "overwrite", + "appendDate" + ], + "type": "string", + "description": "Archive action if account exists" + }, + "ifOfdbDateExists": { + "enum": [ + "abort", + "replaceDate", + "appendSecurities" + ], + "type": "string", + "description": "Action if ofdb date exists" } - }, - "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." - } - } + } + }, + "OptimizerStats": { + "type": "object" + }, + "OptimizerOutputTypes": { + "type": "object", + "properties": { + "trades": { + "$ref": "#/components/schemas/OptimizerTradesList" + }, + "optimal": { + "$ref": "#/components/schemas/OptimizerOptimalHoldings" + }, + "account": { + "$ref": "#/components/schemas/OptimalPortfolio" + }, + "stats": { + "$ref": "#/components/schemas/OptimizerStats" } - }, - "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." - } - } + } + }, + "AFIOptimizationParameters": { + "required": [ + "outputTypes", + "strategy" + ], + "type": "object", + "properties": { + "strategy": { + "$ref": "#/components/schemas/AFIOptimizerStrategy" + }, + "account": { + "$ref": "#/components/schemas/OptimizerAccount" + }, + "optimization": { + "$ref": "#/components/schemas/Optimization" + }, + "outputTypes": { + "$ref": "#/components/schemas/OptimizerOutputTypes" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "204", - "response-type": null + "OptimizerCalculationMeta": { + "type": "object" + }, + "AFIOptimizationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AFIOptimizationParameters" + }, + "meta": { + "$ref": "#/components/schemas/OptimizerCalculationMeta" + } } - ] - } - }, - "/analytics/engines/fi/v3/calculations/{id}/status": { - "get": { - "tags": [ - "FICalculations" - ], - "summary": "Get FI 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 body of the response will contain the requested document in JSON.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getCalculationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint", - "required": true, - "schema": { + }, + "CalculationInfo": { + "type": "object", + "properties": { + "calculationId": { "type": "string", - "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" + "description": "Calculation identifier" } } - ], - "responses": { - "201": { - "description": "Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } - } + }, + "CalculationInfoRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CalculationInfo" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } + "meta": { + "type": "object" } - }, - "202": { - "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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" - } - } + } + }, + "ObjectRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object" + }, + "meta": { + "type": "object" } - }, - "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" - } - } + } + }, + "AxiomaEquityOptimizerStrategyOverrides": { + "type": "object", + "properties": { + "objective": { + "type": "string", + "description": "Objective" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } + "tax": { + "type": "string", + "description": "Tax" + }, + "constraints": { + "type": "object", + "additionalProperties": { + "enum": [ + "Disable", + "Enable" + ], + "type": "string" }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "description": "List of constraints" + }, + "alpha": { + "type": "string", + "description": "Alpha" + }, + "transactionCost": { + "type": "string", + "description": "Transaction cost" } - }, - "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" - } - } + } + }, + "AxiomaEquityOptimizerStrategy": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "overrides": { + "$ref": "#/components/schemas/AxiomaEquityOptimizerStrategyOverrides" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "id": { + "type": "string", + "description": "OptimizerStrategy document path" } - }, - "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." - } - } + } + }, + "AxiomaEquityOptimizationParameters": { + "required": [ + "outputTypes", + "strategy" + ], + "type": "object", + "properties": { + "strategy": { + "$ref": "#/components/schemas/AxiomaEquityOptimizerStrategy" + }, + "account": { + "$ref": "#/components/schemas/OptimizerAccount" + }, + "optimization": { + "$ref": "#/components/schemas/Optimization" + }, + "outputTypes": { + "$ref": "#/components/schemas/OptimizerOutputTypes" } - }, - "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" - } - } + } + }, + "AxiomaEquityOptimizationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AxiomaEquityOptimizationParameters" + }, + "meta": { + "$ref": "#/components/schemas/OptimizerCalculationMeta" } - }, - "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." - } - } + } + }, + "ConstraintAction": { + "type": "object", + "properties": { + "item1": { + "type": "string" + }, + "item2": { + "enum": [ + "Disable", + "Enable" + ], + "type": "string" } - }, - "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." - } + } + }, + "BPMOptimizerStrategyAlphaOverride": { + "type": "object", + "properties": { + "formula": { + "type": "string" + }, + "returnType": { + "enum": [ + "Excess", + "Total", + "Active", + "Residual", + "Exceptional" + ], + "type": "string" + }, + "returnMultiplier": { + "type": "string" + } + } + }, + "BPMOptimizerStrategyOverrides": { + "type": "object", + "properties": { + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintAction" }, - "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." - } - } + "description": "List of constraints" + }, + "alpha": { + "$ref": "#/components/schemas/BPMOptimizerStrategyAlphaOverride" + }, + "tax": { + "type": "string", + "description": "Tax\r\nCan be set to \"\" for local" + }, + "transactionCost": { + "type": "string", + "description": "Transaction cost\r\nCan be set to \"\" for local" } } }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" - }, - { - "status-code": "202", - "response-type": null + "BPMOptimizerStrategy": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "overrides": { + "$ref": "#/components/schemas/BPMOptimizerStrategyOverrides" + }, + "id": { + "type": "string", + "description": "OptimizerStrategy document path" + } } - ] - } - }, - "/analytics/engines/fi/v3/calculations/{id}/result": { - "get": { - "tags": [ - "FICalculations" - ], - "summary": "Get FI 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": "getCalculationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get FI calculation status by id endpoint", - "required": true, - "schema": { + }, + "BPMOptimization": { + "type": "object", + "properties": { + "market": { + "type": "string", + "description": "Optimization market" + }, + "investAllCash": { + "type": "boolean", + "description": "Optimization invest all cash" + }, + "riskModelDate": { + "type": "string", + "description": "Risk model date" + }, + "backtestDate": { + "type": "string", + "description": "Backtest date" + }, + "cashflow": { "type": "string", - "description": "from url, provided from the location header in the Get FI calculation status by id endpoint" + "description": "Cash flow" } } - ], - "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" - } - } + }, + "BPMOptimizationParameters": { + "required": [ + "outputTypes", + "strategy" + ], + "type": "object", + "properties": { + "strategy": { + "$ref": "#/components/schemas/BPMOptimizerStrategy" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } + "optimization": { + "$ref": "#/components/schemas/BPMOptimization" + }, + "account": { + "$ref": "#/components/schemas/OptimizerAccount" + }, + "outputTypes": { + "$ref": "#/components/schemas/OptimizerOutputTypes" + } + } + }, + "BPMOptimizationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/BPMOptimizationParameters" + }, + "meta": { + "$ref": "#/components/schemas/OptimizerCalculationMeta" + } + } + }, + "ColumnSummary": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Column Name" + }, + "directory": { + "type": "string", + "description": "Column Directory" + }, + "category": { + "type": "string", + "description": "Column Category" } }, - "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" - } + "description": "Column settings (name, directory, category)" + }, + "ColumnSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ColumnSummary" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "meta": { + "type": "object" } - }, - "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" - } + } + }, + "Column": { + "type": "object", + "properties": { + "defaultstatisticsids": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "Column statistic Id" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "name": { + "type": "string", + "description": "Column Name" + }, + "directory": { + "type": "string", + "description": "Column Directory" + }, + "category": { + "type": "string", + "description": "Column Category" } - }, - "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." - } - } + } + }, + "ColumnRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Column" + }, + "meta": { + "type": "object" } - }, - "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" - } - } + } + }, + "ColumnStatistic": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Column Statistic Name" } - }, - "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." - } + } + }, + "ColumnStatisticRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ColumnStatistic" } + }, + "meta": { + "type": "object" } - }, - "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." - } + } + }, + "ComponentSummary": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Component name." + }, + "category": { + "type": "string", + "description": "Component category." + } + } + }, + "ComponentSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ComponentSummary" } + }, + "meta": { + "type": "object" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ObjectRoot" + "PAIdentifier": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "User's FactSet account path OR benchmark." + }, + "holdingsmode": { + "type": "string", + "description": "Holdings Mode can be B&H, TBR, OMS or EXT." + } } - ] - } - }, - "/analytics/engines/fpo/v3/optimizations": { - "post": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Create and Run FPO optimization", - "description": "This endpoint runs FPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", - "operationId": "postAndOptimize", - "parameters": [ - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds.", - "schema": { - "type": "integer" + }, + "PADateParameters": { + "required": [ + "enddate", + "frequency" + ], + "type": "object", + "properties": { + "startdate": { + "type": "string", + "description": "Calculation's start date." + }, + "enddate": { + "type": "string", + "description": "Calculation's end date." + }, + "frequency": { + "type": "string", + "description": "Calculation's frequency." } }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts max-stale.", - "schema": { + "description": "The date parameters for PA calculation." + }, + "PAComponent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Component identifier." + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of accounts saved in the PA document." + }, + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of benchmarks saved in the PA document." + }, + "currencyisocode": { "type": "string" + }, + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "snapshot": { + "type": "boolean", + "description": "Is the component type snapshot or subperiod." + }, + "path": { + "type": "string", + "description": "The path to the document" + }, + "name": { + "type": "string", + "description": "Component name." + }, + "category": { + "type": "string", + "description": "Component category." } } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FPOOptimizationParametersRoot" - } + }, + "PAComponentRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PAComponent" + }, + "meta": { + "type": "object" } } }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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/CalculationInfoRoot" - } - } + "VaultIdentifier": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "User's FactSet account path OR benchmark." } }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" - } - } + "description": "The account/benchmark parameter for Vault calculation." + }, + "VaultDateParameters": { + "required": [ + "enddate", + "frequency" + ], + "type": "object", + "properties": { + "startdate": { + "type": "string", + "description": "Calculation's start date." }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } + "enddate": { + "type": "string", + "description": "Calculation's end date." + }, + "frequency": { + "type": "string", + "description": "Calculation's frequency." } }, - "400": { - "description": "Invalid optimization 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" - } - } + "description": "The date parameters for Vault calculation" + }, + "VaultComponent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Vault component identifier" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "account": { + "$ref": "#/components/schemas/VaultIdentifier" + }, + "benchmark": { + "$ref": "#/components/schemas/VaultIdentifier" + }, + "currencyisocode": { + "type": "string", + "description": "Currency iso code saved in the document" + }, + "dates": { + "$ref": "#/components/schemas/VaultDateParameters" + }, + "snapshot": { + "type": "boolean", + "description": "Snapshot" + }, + "path": { + "type": "string", + "description": "The path to the document" + }, + "name": { + "type": "string", + "description": "Component name." + }, + "category": { + "type": "string", + "description": "Component category." } - }, - "404": { - "description": "One or more optimization 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" - } - } + } + }, + "VaultComponentRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/VaultComponent" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "meta": { + "type": "object" } - }, - "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." - } - } + } + }, + "VaultConfigurationSummary": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Configuration name." } - }, - "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" - } + } + }, + "VaultConfigurationSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/VaultConfigurationSummary" } + }, + "meta": { + "type": "object" } - }, - "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" - } - } + } + }, + "ConfigurationAccount": { + "type": "object", + "properties": { + "benchmarkCode": { + "type": "string", + "description": "Benchmark code." + }, + "benchmarkName": { + "type": "string", + "description": "Benchmark name." + }, + "maxEndDate": { + "type": "string", + "description": "Maximum end date." + }, + "minStartDate": { + "type": "string", + "description": "Minimum start date." + }, + "lockingDate": { + "type": "string", + "description": "Locking date." + }, + "name": { + "type": "string", + "description": "Account name." } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } + } + }, + "VaultConfiguration": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Configuration name." + }, + "accounts": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConfigurationAccount" } } - }, - "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." - } - } + } + }, + "VaultConfigurationRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/VaultConfiguration" + }, + "meta": { + "type": "object" } - }, - "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." - } - } + } + }, + "Currency": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of currency." } } }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" + "CurrencyRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Currency" + } + }, + "meta": { + "type": "object" + } } - ] - } - }, - "/analytics/engines/fpo/v3/optimizations/{id}": { - "put": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Create or Update FPO optimization and run it.", - "description": "This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id.", - "operationId": "putAndOptimize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", - "required": true, - "schema": { + }, + "DateParametersSummary": { + "type": "object", + "properties": { + "startdate": { + "type": "string", + "description": "Start date in YYYYMMDD format." + }, + "enddate": { "type": "string", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + "description": "End date in YYYYMMDD format." } - }, - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds.", - "schema": { - "type": "integer" + } + }, + "DateParametersSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DateParametersSummary" + }, + "meta": { + "type": "object" } - }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts max-stale.", - "schema": { + } + }, + "FIDiscountCurveInfo": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "name": { + "type": "string" + }, + "currency": { "type": "string" } } - ], - "requestBody": { - "description": "Optimization Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FPOOptimizationParametersRoot" + }, + "FIDiscountCurveInfoRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/FIDiscountCurveInfo" } + }, + "meta": { + "type": "object" } } }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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" - } + "DocumentDirectories": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } + "description": "List of documents" + }, + "directories": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of directories." + } + } + }, + "DocumentDirectoriesRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentDirectories" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CalculationInfoRoot" - } - } + "meta": { + "type": "object" } - }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" - } - } + } + }, + "FIABIdentifier": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "User's FactSet account path." + } + } + }, + "FIABDateParameters": { + "required": [ + "enddate", + "startdate" + ], + "type": "object", + "properties": { + "startdate": { + "type": "string", + "description": "Calculation's start date." }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } + "enddate": { + "type": "string", + "description": "Calculation's end date." } }, - "400": { - "description": "Invalid Optimization 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" - } - } + "description": "The date parameters for FIAB calculations." + }, + "FIABCalculationParameters": { + "required": [ + "account", + "dates" + ], + "type": "object", + "properties": { + "fiabdocument": { + "type": "string", + "description": "FiabDocument (optional) - FIAB document to use as a template. Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "account": { + "$ref": "#/components/schemas/FIABIdentifier" + }, + "dates": { + "$ref": "#/components/schemas/FIABDateParameters" + }, + "msl": { + "type": "string", + "description": "Master FISecurity List. Analytics results will be written to the selected MSL. Expects a GUI-style path (Client:/foo/bar)" + }, + "fisettingsdocument": { + "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)" } - }, - "404": { - "description": "One or more optimization 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" - } - } + } + }, + "FIABCalculationStatusSummary": { + "type": "object", + "properties": { + "requesttime": { + "type": "string", + "description": "Request time of calculation.", + "format": "date-time" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "lastpolltime": { + "type": "string", + "description": "Last poll time of calculation.", + "format": "date-time" } - }, - "409": { - "description": "Duplicate optimization exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + } + }, + "EventSummary": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Event's message" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "submissiondatetime": { + "type": "string", + "description": "Event's submission time", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "Event's type" } - }, - "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." - } + } + }, + "FIABCalculationStatus": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Calculation's identifier" + }, + "status": { + "enum": [ + "Pending", + "InProgress", + "Done", + "Paused", + "Cancelled", + "Error" + ], + "type": "string", + "description": "Calculation's status" + }, + "startdatetime": { + "type": "string", + "description": "Start time", + "format": "date-time" + }, + "completiondatetime": { + "type": "string", + "description": "Completion time", + "format": "date-time" + }, + "progress": { + "type": "integer", + "description": "Calculation's progress", + "format": "int32" + }, + "batchevents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventSummary" }, - "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." - } - } + "description": "List of batch events" } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + } + }, + "FIReferencePrepay": { + "type": "object", + "properties": { + "prepayName": { + "type": "string", + "description": "Reference Prepay Name" } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } - } + } + }, + "FIReferenceSecurity": { + "type": "object", + "properties": { + "securityType": { + "type": "string", + "description": "Reference Security Type" + }, + "securityName": { + "type": "string", + "description": "Reference Security Name" + }, + "calcFromMethod": { + "type": "string", + "description": "Reference Calculation Method.\r\nMethods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + }, + "calcFromValue": { + "type": "number", + "description": "Reference CalcFromValue", + "format": "double" + }, + "prepay": { + "$ref": "#/components/schemas/FIReferencePrepay" + }, + "settlement": { + "type": "string", + "description": "Reference Settlement Date" } - }, - "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." - } - } + } + }, + "FIBankLoans": { + "type": "object", + "properties": { + "ignoreSinkingFund": { + "type": "boolean", + "description": "Ignore Sinking Fund" } - }, - "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." - } - } + } + }, + "FIMunicipalBonds": { + "type": "object", + "properties": { + "ignoreSinkingFund": { + "type": "boolean", + "description": "Ignore Sinking Fund Schedule" + }, + "useAnticipatedSinkSchedule": { + "type": "boolean", + "description": "Anticipate Sink Schedule" } } }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" + "FILoss": { + "type": "object", + "properties": { + "lossName": { + "type": "string", + "description": "Loss Name" + } } - ] - }, - "get": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Get FPO optimization parameters by id", - "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", - "operationId": "getOptimizationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", - "required": true, - "schema": { + }, + "FIPrepay": { + "type": "object", + "properties": { + "prepayName": { "type": "string", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + "description": "Prepay Name" } } - ], - "responses": { - "200": { - "description": "Expected response, returns the FPO optimization 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" - } - } + }, + "FIServicerAdvancesForSecurities": { + "type": "object", + "properties": { + "principal": { + "type": "number", + "description": "Principal", + "format": "double" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FPOOptimizationParametersRoot" - } - } - } - }, - "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" - } - } + "interest": { + "type": "number", + "description": "Interest", + "format": "double" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "advanceType": { + "enum": [ + "Advances All", + "Advances All But Newly Liqdtd", + "Does Not Advance", + "Principal Only", + "Interest Only" + ], + "type": "string", + "description": "Advance Type" } - }, - "404": { - "description": "Optimization 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" - } - } + } + }, + "FIPrepayLockout": { + "type": "object", + "properties": { + "pointsAbove": { + "enum": [ + "ANY", + "NO_LOCKOUT", + "NUMERIC" + ], + "type": "string", + "description": "Points Above" }, - "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." - } - } + "ymAbove": { + "enum": [ + "ANY", + "NO_LOCKOUT", + "NUMERIC" + ], + "type": "string", + "description": "Ym Above" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FPOOptimizationParametersRoot" + "FICashflows": { + "type": "object", + "properties": { + "optionalRedemptionCallWhenUnits": { + "enum": [ + "Manual", + "Never", + "ASAP", + "Date", + "Deal Closing", + "Settle Date" + ], + "type": "string", + "description": "OptionalRedemptionCallWhenUnits" + }, + "optionalRedemptionCallWhen": { + "type": "integer", + "description": "OptionalRedemptionCallWhen", + "format": "int32" + }, + "recoveryLag": { + "type": "integer", + "description": "RecoveryLag", + "format": "int32" + } } - ] - }, - "delete": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Cancel FPO optimization by id", - "description": "This is the endpoint to cancel a previously submitted optimization.", - "operationId": "cancelOptimizationById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", - "required": true, - "schema": { + }, + "FIBalloonExtension": { + "type": "object", + "properties": { + "months": { + "type": "integer", + "description": "Months", + "format": "int32" + }, + "percentage": { + "type": "number", + "description": "Percentage", + "format": "double" + }, + "amortizationType": { + "enum": [ + "Loan_Amort_None", + "Loan_Amort_Regular", + "Loan_Amort_Default" + ], "type": "string", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + "description": "Amortization Type" + }, + "units": { + "type": "string", + "description": "Units" + }, + "couponStepup": { + "type": "number", + "description": "Coupon Stepup", + "format": "double" } } - ], - "responses": { - "204": { - "description": "Expected response, optimization was canceled 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" - } - } + }, + "FIStructuredProductsForSecurities": { + "type": "object", + "properties": { + "servicerAdvances": { + "$ref": "#/components/schemas/FIServicerAdvancesForSecurities" + }, + "ignoreFinancialGuarantee": { + "type": "string", + "description": "Ignore Financial Guarantee" + }, + "cleanUpCallMethod": { + "type": "boolean", + "description": "Cleanup Call Method" + }, + "doOPTRedeem": { + "type": "string", + "description": "Do OPT Redeem" + }, + "prepayLockout": { + "$ref": "#/components/schemas/FIPrepayLockout" + }, + "cashflows": { + "$ref": "#/components/schemas/FICashflows" + }, + "balloonExtension": { + "$ref": "#/components/schemas/FIBalloonExtension" } - }, - "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" - } - } + } + }, + "FISecurity": { + "required": [ + "calcFromValue", + "symbol" + ], + "type": "object", + "properties": { + "settlement": { + "type": "string", + "description": "Settlement date" }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "callMethod": { + "enum": [ + "No Call", + "Intrinsic Value", + "First Call", + "First Par" + ], + "type": "string", + "description": "Call Method" + }, + "referenceSecurity": { + "$ref": "#/components/schemas/FIReferenceSecurity" + }, + "bankLoans": { + "$ref": "#/components/schemas/FIBankLoans" + }, + "municipalBonds": { + "$ref": "#/components/schemas/FIMunicipalBonds" + }, + "loss": { + "$ref": "#/components/schemas/FILoss" + }, + "prepay": { + "$ref": "#/components/schemas/FIPrepay" + }, + "matrixSpreadAdjustment": { + "type": "number", + "description": "Matrix Spread Adjustment", + "format": "double" + }, + "matrixMultiplier": { + "type": "number", + "description": "Matrix Multiplier", + "format": "double" + }, + "structuredProducts": { + "$ref": "#/components/schemas/FIStructuredProductsForSecurities" + }, + "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" + }, + "calcFromValue": { + "type": "number", + "description": "Calculation from value", + "format": "double" + }, + "face": { + "type": "number", + "description": "Face", + "format": "double", + "default": 1 + }, + "faceType": { + "enum": [ + "Current", + "Original" + ], + "type": "string", + "description": "Face type", + "default": "Current" + }, + "symbol": { + "type": "string", + "description": "Symbol" + }, + "discountCurve": { + "type": "string", + "description": "Discount curve" } - }, - "404": { - "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } - } + } + }, + "FIMunicipalBondsForJobSettings": { + "type": "object", + "properties": { + "allowSinkForInstallmentPayment": { + "type": "boolean", + "description": "Allow Sink For Installment Payment" }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "ignoreSinkingFund": { + "type": "boolean", + "description": "Ignore Sinking Fund Schedule" + }, + "useAnticipatedSinkSchedule": { + "type": "boolean", + "description": "Anticipate Sink Schedule" } - }, - "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." - } - } + } + }, + "FIMarketEnvironment": { + "type": "object", + "properties": { + "ratePath": { + "enum": [ + "FLAT", + "FORWARD", + "FLAT & FORWARD" + ], + "type": "string", + "description": "Rate Path", + "default": "FLAT & FORWARD" } - }, - "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." - } + } + }, + "FIServicerAdvances": { + "type": "object", + "properties": { + "advanceType": { + "enum": [ + "Advances All", + "Advances All But Newly Liqdtd", + "Does Not Advance", + "Principal Only", + "Interest Only" + ], + "type": "string", + "description": "Advance Type" + } + } + }, + "FIStructuredProductsForJobSettings": { + "type": "object", + "properties": { + "servicerAdvances": { + "$ref": "#/components/schemas/FIServicerAdvances" + }, + "ignoreFinancialGuarantee": { + "type": "string", + "description": "Ignore Financial Guarantee" + }, + "cleanUpCallMethod": { + "type": "boolean", + "description": "Cleanup Call Method" + }, + "doOPTRedeem": { + "type": "string", + "description": "Do OPT Redeem" + }, + "prepayLockout": { + "$ref": "#/components/schemas/FIPrepayLockout" + }, + "cashflows": { + "$ref": "#/components/schemas/FICashflows" + }, + "balloonExtension": { + "$ref": "#/components/schemas/FIBalloonExtension" + } + } + }, + "FIJobSettings": { + "required": [ + "asOfDate" + ], + "type": "object", + "properties": { + "asOfDate": { + "type": "string", + "description": "As of date" + }, + "partialDurationMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } + "description": "Partial duration months" + }, + "callMethod": { + "enum": [ + "No Call", + "Intrinsic Value", + "First Call", + "First Par" + ], + "type": "string", + "description": "Call Method" + }, + "settlement": { + "type": "string", + "description": "Settlement Date" + }, + "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" + }, + "bankLoans": { + "$ref": "#/components/schemas/FIBankLoans" + }, + "municipalBonds": { + "$ref": "#/components/schemas/FIMunicipalBondsForJobSettings" + }, + "marketEnvironment": { + "$ref": "#/components/schemas/FIMarketEnvironment" + }, + "structuredProducts": { + "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" + } + } + }, + "FICalculationParameters": { + "required": [ + "calculations", + "jobSettings", + "securities" + ], + "type": "object", + "properties": { + "securities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FISecurity" }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } + "description": "List of securities" + }, + "calculations": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of calculations" + }, + "jobSettings": { + "$ref": "#/components/schemas/FIJobSettings" } - }, - "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." - } + } + }, + "CalculationMeta": { + "type": "object", + "properties": { + "contentorganization": { + "enum": [ + "None", + "Row", + "Column", + "SimplifiedRow" + ], + "type": "string", + "default": "SimplifiedRow", + "deprecated": true + }, + "stachContentOrganization": { + "enum": [ + "None", + "Row", + "Column", + "SimplifiedRow" + ], + "type": "string", + "default": "SimplifiedRow" + }, + "contenttype": { + "enum": [ + "Json", + "Binary" + ], + "type": "string", + "default": "Json", + "deprecated": true + }, + "format": { + "enum": [ + "JsonStach", + "Table", + "Tableau", + "BinaryStach", + "Bison", + "Binary", + "Pdf", + "Pptx", + "Feather" + ], + "type": "string", + "default": "JsonStach" + } + } + }, + "FICalculationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FICalculationParameters" + }, + "meta": { + "$ref": "#/components/schemas/CalculationMeta" + } + } + }, + "PaDoc": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "PA document path" + } + } + }, + "FPOAccount": { + "required": [ + "paDocument" + ], + "type": "object", + "properties": { + "paDocument": { + "$ref": "#/components/schemas/PaDoc" + }, + "id": { + "type": "string", + "description": "Account path" + }, + "overrides": { + "$ref": "#/components/schemas/OptimizerAccountOverrides" + } + } + }, + "FPOObjective": { + "type": "object", + "properties": { + "active": { + "type": "string" + }, + "terms": { + "type": "object", + "additionalProperties": { + "enum": [ + "Disable", + "Enable" + ], + "type": "string" } } - }, - "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." - } + } + }, + "FPOOptimizerStrategyOverrides": { + "type": "object", + "properties": { + "objective": { + "$ref": "#/components/schemas/FPOObjective" + }, + "constraints": { + "type": "object", + "additionalProperties": { + "enum": [ + "Disable", + "Enable" + ], + "type": "string" }, - "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." - } - } + "description": "List of constraints" + }, + "alpha": { + "type": "string", + "description": "Alpha" + }, + "transactionCost": { + "type": "string", + "description": "Transaction cost" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "204", - "response-type": null + "FPOOptimizerStrategy": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "overrides": { + "$ref": "#/components/schemas/FPOOptimizerStrategyOverrides" + }, + "id": { + "type": "string", + "description": "OptimizerStrategy document path" + } } - ] - } - }, - "/analytics/engines/fpo/v3/optimizations/{id}/status": { - "get": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Get FPO optimization status by id", - "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getOptimizationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint", - "required": true, - "schema": { + }, + "FPOOptimizationParameters": { + "required": [ + "outputTypes", + "strategy" + ], + "type": "object", + "properties": { + "account": { + "$ref": "#/components/schemas/FPOAccount" + }, + "strategy": { + "$ref": "#/components/schemas/FPOOptimizerStrategy" + }, + "optimization": { + "$ref": "#/components/schemas/Optimization" + }, + "outputTypes": { + "$ref": "#/components/schemas/OptimizerOutputTypes" + } + } + }, + "FPOOptimizationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FPOOptimizationParameters" + }, + "meta": { + "$ref": "#/components/schemas/OptimizerCalculationMeta" + } + } + }, + "Frequency": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" + "description": "Frequency name." } } - ], - "responses": { - "201": { - "description": "Expected response once optimization is completed, returns 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" - } + }, + "FrequencyRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Frequency" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } + "meta": { + "type": "object" + } + } + }, + "Group": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Group Name" + }, + "directory": { + "type": "string", + "description": "Group Directory" + }, + "category": { + "type": "string", + "description": "Group Category" + } + } + }, + "GroupRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Group" } + }, + "meta": { + "type": "object" } - }, - "202": { - "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "schema": { - "type": "string", - "description": "FactSet's progress header." - } + } + }, + "TemplateContentTypes": { + "type": "object", + "properties": { + "mandatory": { + "type": "array", + "items": { + "type": "string" }, - "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" - } + "description": "Template mandatory fields" + }, + "optional": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } + "description": "Template optional fields" + }, + "locked": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "Template locked fields" } - }, - "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" - } - } + } + }, + "LinkedPATemplateParameters": { + "required": [ + "directory", + "parentComponentId" + ], + "type": "object", + "properties": { + "directory": { + "type": "string", + "description": "The directory to create a linked PA template" + }, + "parentComponentId": { + "type": "string", + "description": "Parent component id" + }, + "description": { + "type": "string", + "description": "Template description" }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "$ref": "#/components/schemas/TemplateContentTypes" } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } - } + } + }, + "LinkedPATemplateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LinkedPATemplateParameters" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "meta": { + "type": "object" } - }, - "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." - } - } + } + }, + "LinkedPATemplatePostSummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Template id." + }, + "description": { + "type": "string", + "description": "Template description." + }, + "name": { + "type": "string", + "description": "Template name." + }, + "parentComponentId": { + "type": "string", + "description": "Template parent tile." } - }, - "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" - } - } + } + }, + "LinkedPATemplatePostSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LinkedPATemplatePostSummary" + }, + "meta": { + "type": "object" } - }, - "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." - } - } + } + }, + "LinkedPATemplateSummary": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Template description." + }, + "name": { + "type": "string", + "description": "Template name." + }, + "parentComponentId": { + "type": "string", + "description": "Template parent tile." } - }, - "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." - } + } + }, + "LinkedPATemplateSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/LinkedPATemplateSummary" } + }, + "meta": { + "type": "object" } } }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" - }, - { - "status-code": "202", - "response-type": null + "LinkedPATemplateUpdateParameters": { + "type": "object", + "properties": { + "parentComponentId": { + "type": "string", + "description": "Parent component id" + }, + "description": { + "type": "string", + "description": "Template description" + }, + "content": { + "$ref": "#/components/schemas/TemplateContentTypes" + } } - ] - } - }, - "/analytics/engines/fpo/v3/optimizations/{id}/result": { - "get": { - "tags": [ - "FPO Optimizer" - ], - "summary": "Get FPO optimization result by id", - "description": "This is the endpoint to get the result of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.", - "operationId": "getOptimizationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint", - "required": true, - "schema": { + }, + "LinkedPATemplateUpdateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LinkedPATemplateUpdateParameters" + }, + "meta": { + "type": "object" + } + } + }, + "LinkedPATemplate": { + "type": "object", + "properties": { + "directory": { + "type": "string", + "description": "Template directory." + }, + "snapshot": { + "type": "boolean", + "description": "snapshot." + }, + "content": { + "$ref": "#/components/schemas/TemplateContentTypes" + }, + "id": { + "type": "string", + "description": "Template id." + }, + "description": { + "type": "string", + "description": "Template description." + }, + "name": { "type": "string", - "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint" + "description": "Template name." + }, + "parentComponentId": { + "type": "string", + "description": "Template parent tile." } - }, - { - "name": "Accept", - "in": "header", - "description": "Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or *", - "schema": { - "type": "string" + } + }, + "LinkedPATemplateRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LinkedPATemplate" + }, + "meta": { + "type": "object" } } - ], - "responses": { - "200": { - "description": "Expected response once optimization is completed, returns JSON.", - "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." - } + }, + "NPOOptimizerStrategyOverrides": { + "type": "object", + "properties": { + "objective": { + "type": "object", + "additionalProperties": { + "type": "object" }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } + "description": "Objective parameters" + }, + "constraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintAction" }, - "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." - } + "description": "List of constraints" + }, + "tax": { + "type": "string", + "description": "Tax\r\nCan be set to \"\" for local" + }, + "transactionCost": { + "type": "string", + "description": "Transaction cost\r\nCan be set to \"\" for local" + }, + "alpha": { + "type": "string", + "description": "Alpha" + } + } + }, + "NPOOptimizerStrategy": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "overrides": { + "$ref": "#/components/schemas/NPOOptimizerStrategyOverrides" + }, + "id": { + "type": "string", + "description": "OptimizerStrategy document path" + } + } + }, + "NPOOptimizationParameters": { + "required": [ + "outputTypes", + "strategy" + ], + "type": "object", + "properties": { + "strategy": { + "$ref": "#/components/schemas/NPOOptimizerStrategy" + }, + "account": { + "$ref": "#/components/schemas/OptimizerAccount" + }, + "optimization": { + "$ref": "#/components/schemas/Optimization" + }, + "outputTypes": { + "$ref": "#/components/schemas/OptimizerOutputTypes" + } + } + }, + "NPOOptimizationParametersRoot": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NPOOptimizationParameters" + }, + "meta": { + "$ref": "#/components/schemas/OptimizerCalculationMeta" + } + } + }, + "PACalculationGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "FactSet-defined or User-defined Group identifier." + }, + "frequency": { + "type": "string", + "description": "Grouping frequency" + } + } + }, + "PACalculationColumn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "FactSet-defined or User-defined Column identifier." + }, + "statistics": { + "type": "array", + "items": { + "type": "string" }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } + "description": "Column Statistic identifier" + } + } + }, + "PACalculationPricingSource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Pricing source identifier" + } + } + }, + "PACalculationDataSources": { + "type": "object", + "properties": { + "portfoliopricingsources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationPricingSource" }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } + "description": "List of portfilio pricing source for the PA calculation" + }, + "benchmarkpricingsources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationPricingSource" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of benchmark pricing source for the PA calculation" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } + "useportfoliopricingsourcesforbenchmark": { + "type": "boolean", + "description": "Use portfolio pricing sources for benchmark" } - }, - "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." - } + } + }, + "PACalculationParameters": { + "required": [ + "componentid" + ], + "type": "object", + "properties": { + "componentid": { + "type": "string", + "description": "The PA Engine component identifier to analyze." + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" }, - "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." - } + "description": "List of accounts." + }, + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } + "description": "List of benchmarks." + }, + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationGroup" }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } + "description": "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document." + }, + "currencyisocode": { + "type": "string", + "description": "Currency ISO code for calculation." + }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationColumn" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document." }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "datasources": { + "$ref": "#/components/schemas/PACalculationDataSources" + }, + "componentdetail": { + "type": "string", + "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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" - } + } + }, + "PACalculationParametersRoot": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/PACalculationParameters" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of calculation parameters." }, - "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." - } - } + "meta": { + "$ref": "#/components/schemas/CalculationMeta" } - }, - "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" - } + } + }, + "CalculationUnitStatus": { + "type": "object", + "properties": { + "status": { + "enum": [ + "Queued", + "Executing", + "Success", + "Failed", + "Cancelled" + ], + "type": "string", + "description": "The status of calculation unit." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" }, - "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." - } + "description": "The error in a calculation unit." + }, + "result": { + "type": "string", + "description": "The result URL of the calculation." + }, + "progress": { + "type": "string", + "description": "The progress of the calculation unit." + }, + "points": { + "type": "integer", + "description": "The points for the calculation unit.", + "format": "int32" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" }, - "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." - } - } + "description": "The warnings in a calculation unit." } - }, - "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." - } + } + }, + "CalculationStatus": { + "type": "object", + "properties": { + "calculationid": { + "type": "string", + "description": "Calculation's identifier" + }, + "status": { + "enum": [ + "Queued", + "Executing", + "Completed", + "Cancelled" + ], + "type": "string", + "description": "Calculation's status" + }, + "units": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CalculationUnitStatus" }, - "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." - } - } + "description": "Number of calculation units in batch." } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "ObjectRoot" + "CalculationUnitStatusMeta": { + "type": "object", + "properties": { + "info": { + "type": "string", + "description": "The Info URL of the calculation." + } } - ] - } - }, - "/analytics/engines/pa/v3/frequencies": { - "get": { - "tags": [ - "Frequencies" - ], - "summary": "Get PA frequencies", - "description": "This endpoint lists all the frequencies that can be applied to a PA calculation.", - "operationId": "getPAFrequencies", - "responses": { - "200": { - "description": "Expected response, returns a list of PA frequencies.", - "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" - } + }, + "CalculationStatusMeta": { + "type": "object", + "properties": { + "units": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CalculationUnitStatusMeta" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "Meta of calculation units in batch." + } + } + }, + "CalculationStatusRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CalculationStatus" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyRoot" - } - } + "meta": { + "$ref": "#/components/schemas/CalculationStatusMeta" } - }, - "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." - } - } + } + }, + "CalculationsSummary": { + "type": "object", + "properties": { + "status": { + "enum": [ + "Queued", + "Executing", + "Completed", + "Cancelled" + ], + "type": "string", + "description": "Last poll status of the calculation." + }, + "units": { + "type": "integer", + "description": "Number of calculation units in batch.", + "format": "int32" + }, + "requestTime": { + "type": "string", + "description": "Request time of calculation.", + "format": "date-time" + }, + "lastPollTime": { + "type": "string", + "description": "Last poll time of calculation.", + "format": "date-time" } - }, - "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" - } - } + } + }, + "PaginationInfo": { + "type": "object", + "properties": { + "pageNumber": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "totalPages": { + "type": "integer", + "format": "int32" + }, + "totalCalculations": { + "type": "integer", + "format": "int32" + }, + "nextPage": { + "type": "string" + }, + "previousPage": { + "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" - } - } + } + }, + "PaginationMeta": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/PaginationInfo" } - }, - "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" - } - } + } + }, + "CalculationsSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CalculationsSummary" + }, + "meta": { + "$ref": "#/components/schemas/PaginationMeta" } - }, - "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." - } - } + } + }, + "PAPricingSource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Pricing source Name" + }, + "directory": { + "type": "string", + "description": "Pricing source directory" + }, + "category": { + "type": "string", + "description": "Pricing source category" } - }, - "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." - } + } + }, + "PAPricingSourceRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/PAPricingSource" } + }, + "meta": { + "type": "object" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FrequencyRoot" + "PubIdentifier": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "User's FactSet account path OR benchmark." + }, + "holdingsmode": { + "type": "string", + "description": "Holdings Mode can be B&H, TBR, OMS or EXT." + } } - ] - } - }, - "/analytics/engines/spar/v3/frequencies": { - "get": { - "tags": [ - "Frequencies" - ], - "summary": "Get SPAR frequencies", - "description": "This endpoint lists all the frequencies that can be applied to a SPAR calculation.", - "operationId": "getSPARFrequencies", - "responses": { - "200": { - "description": "Expected response, returns a list of SPAR frequencies.", - "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" - } - } + }, + "PubDateParameters": { + "required": [ + "enddate" + ], + "type": "object", + "properties": { + "startdate": { + "type": "string", + "description": "Calculation's start date." }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyRoot" - } - } + "enddate": { + "type": "string", + "description": "Calculation's end date or as of 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." - } + "description": "The date parameters for Publisher calculation." + }, + "PubCalculationParameters": { + "required": [ + "account", + "dates", + "document" + ], + "type": "object", + "properties": { + "document": { + "type": "string", + "description": "The Publisher Engine document to analyze." + }, + "account": { + "$ref": "#/components/schemas/PubIdentifier" + }, + "dates": { + "$ref": "#/components/schemas/PubDateParameters" + } + } + }, + "PubCalculationMeta": { + "type": "object" + }, + "PubCalculationParametersRoot": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/PubCalculationParameters" }, - "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." - } - } + "description": "List of calculation parameters." + }, + "meta": { + "$ref": "#/components/schemas/PubCalculationMeta" } - }, - "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" - } - } + } + }, + "QuantScreeningExpressionUniverse": { + "required": [ + "universeExpr", + "universeType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantUniverse" } - }, - "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" - } - } + ], + "properties": { + "universeExpr": { + "type": "string" + }, + "universeType": { + "enum": [ + "Equity", + "Debt" + ], + "type": "string" + }, + "securityExpr": { + "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" - } - } + } + }, + "QuantIdentifierUniverse": { + "required": [ + "identifiers", + "universeType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantUniverse" } - }, - "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." - } + ], + "properties": { + "universeType": { + "enum": [ + "Equity", + "Debt" + ], + "type": "string" + }, + "identifiers": { + "type": "array", + "items": { + "type": "string" } } - }, - "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." - } - } + } + }, + "QuantUniverse": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FrequencyRoot" + "QuantUniversalScreenUniverse": { + "required": [ + "screen" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantUniverse" + } + ], + "properties": { + "screen": { + "type": "string" + } } - ] - } - }, - "/analytics/engines/vault/v3/frequencies": { - "get": { - "tags": [ - "Frequencies" - ], - "summary": "Get Vault frequencies", - "description": "This endpoint lists all the frequencies that can be applied to a Vault calculation.", - "operationId": "getVaultFrequencies", - "responses": { - "200": { - "description": "Expected response, returns a list of Vault frequencies.", - "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" - } + }, + "QuantDateList": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantDate" + } + ], + "properties": { + "dates": { + "type": "array", + "items": { + "type": "string" } + } + } + }, + "QuantDate": { + "required": [ + "calendar", + "frequency", + "source" + ], + "type": "object", + "properties": { + "source": { + "enum": [ + "FdsDate", + "DateList" + ], + "type": "string" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyRoot" - } - } + "frequency": { + "type": "string" + }, + "calendar": { + "type": "string" + }, + "overrideUniversalScreenCalendar": { + "type": "boolean" } - }, - "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." - } - } + } + }, + "QuantFdsDate": { + "required": [ + "endDate", + "startDate" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantDate" } - }, - "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" - } - } + ], + "properties": { + "startDate": { + "type": "string" + }, + "endDate": { + "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" - } - } + } + }, + "QuantFqlExpression": { + "required": [ + "expr", + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" } - }, - "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" - } - } + ], + "properties": { + "expr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "dateOffset": { + "type": "string" + }, + "isArrayReturnType": { + "type": "boolean" } - }, - "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." - } - } + } + }, + "QuantUniversalScreenParameter": { + "required": [ + "name", + "referenceName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" } - }, - "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." - } - } + ], + "properties": { + "referenceName": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FrequencyRoot" + "QuantAllUniversalScreenParameters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ] + }, + "QuantFormula": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "enum": [ + "ScreeningExpression", + "FqlExpression", + "UniversalScreenParameter", + "AllUniversalScreenParameters" + ], + "type": "string" + } } - ] - } - }, - "/analytics/engines/pa/v3/groups": { - "get": { - "tags": [ - "Groups" - ], - "summary": "Get PA groups", - "description": "This endpoint lists all the PA groups that can be applied to a PA calculation.", - "operationId": "getPAGroups", - "responses": { - "200": { - "description": "Expected response, returns a list of PA groups", - "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." - } - }, - "Age": { - "description": "Standard HTTP header. Header will specify the age of groupings list cached response.", - "schema": { - "type": "integer", - "description": "Standard HTTP header. Header will specify the age of groupings list cached response." - } - }, - "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" - } - } + }, + "QuantScreeningExpression": { + "required": [ + "expr", + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ], + "properties": { + "expr": { + "type": "string" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupRoot" - } - } + "name": { + "type": "string" + }, + "dateOffset": { + "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." - } - } + } + }, + "QuantScreeningExpressionUniverseObsolete": { + "required": [ + "universeExpr", + "universeType" + ], + "type": "object", + "properties": { + "universeExpr": { + "type": "string" + }, + "universeType": { + "enum": [ + "Equity", + "Debt" + ], + "type": "string" + }, + "securityExpr": { + "type": "string" + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - }, - "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" - } - } + } + }, + "QuantUniversalScreenUniverseObsolete": { + "required": [ + "screen" + ], + "type": "object", + "properties": { + "screen": { + "type": "string" + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "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" - } + } + }, + "QuantIdentifierUniverseObsolete": { + "required": [ + "identifiers", + "universeType" + ], + "type": "object", + "properties": { + "universeType": { + "enum": [ + "Equity", + "Debt" + ], + "type": "string" + }, + "identifiers": { + "type": "array", + "items": { + "type": "string" } + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - }, - "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" - } - } + } + }, + "QuantFdsDateObsolete": { + "required": [ + "calendar", + "endDate", + "frequency", + "startDate" + ], + "type": "object", + "properties": { + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "frequency": { + "type": "string" + }, + "calendar": { + "type": "string" + }, + "overrideUniversalScreenCalendar": { + "type": "boolean" } - }, - "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." - } + } + }, + "QuantDateListObsolete": { + "required": [ + "calendar", + "frequency" + ], + "type": "object", + "properties": { + "dates": { + "type": "array", + "items": { + "type": "string" } + }, + "frequency": { + "type": "string" + }, + "calendar": { + "type": "string" + }, + "overrideUniversalScreenCalendar": { + "type": "boolean" } - }, - "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." - } - } + } + }, + "QuantScreeningExpressionObsolete": { + "required": [ + "expr", + "name" + ], + "type": "object", + "properties": { + "expr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "dateOffset": { + "type": "string" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "GroupRoot" + "QuantFqlExpressionObsolete": { + "required": [ + "expr", + "name" + ], + "type": "object", + "properties": { + "expr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "dateOffset": { + "type": "string" + }, + "isArrayReturnType": { + "type": "boolean" + } } - ] - } - }, - "/analytics/engines/pa/v3/grouping-frequencies": { - "get": { - "tags": [ - "Groups" - ], - "summary": "Get PA grouping frequencies", - "description": "This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation.", - "operationId": "getPAGroupingFrequencies", - "responses": { - "200": { - "description": "Expected response, returns a list of PA grouping frequencies", - "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" - } - } + }, + "QuantUniversalScreenParameterObsolete": { + "required": [ + "name", + "referenceName" + ], + "type": "object", + "properties": { + "referenceName": { + "type": "string" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyRoot" - } - } + "name": { + "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." - } - } + } + }, + "QuantAllUniversalScreenParametersObsolete": { + "type": "object" + }, + "OneOfQuantUniverse": { + "oneOf": [ + { + "$ref": "#/components/schemas/QuantUniversalScreenUniverse" + }, + { + "$ref": "#/components/schemas/QuantScreeningExpressionUniverse" + }, + { + "$ref": "#/components/schemas/QuantIdentifierUniverse" } - }, - "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" - } - } + ], + "discriminator": { + "propertyName": "source", + "mapping": { + "UniversalScreenUniverse": "#/components/schemas/QuantUniversalScreenUniverse", + "ScreeningExpressionUniverse": "#/components/schemas/QuantScreeningExpressionUniverse", + "IdentifierUniverse": "#/components/schemas/QuantIdentifierUniverse" } - }, - "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" - } - } + } + }, + "OneOfQuantDates": { + "oneOf": [ + { + "$ref": "#/components/schemas/QuantFdsDate" + }, + { + "$ref": "#/components/schemas/QuantDateList" } - }, - "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" - } - } + ], + "discriminator": { + "propertyName": "source", + "mapping": { + "FdsDate": "#/components/schemas/QuantFdsDate", + "DateList": "#/components/schemas/QuantDateList" } - }, - "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." - } - } + } + }, + "OneOfQuantFormulas": { + "oneOf": [ + { + "$ref": "#/components/schemas/QuantScreeningExpression" + }, + { + "$ref": "#/components/schemas/QuantFqlExpression" + }, + { + "$ref": "#/components/schemas/QuantUniversalScreenParameter" + }, + { + "$ref": "#/components/schemas/QuantAllUniversalScreenParameters" } - }, - "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." - } - } + ], + "discriminator": { + "propertyName": "source", + "mapping": { + "ScreeningExpression": "#/components/schemas/QuantScreeningExpression", + "FqlExpression": "#/components/schemas/QuantFqlExpression", + "UniversalScreenParameter": "#/components/schemas/QuantUniversalScreenParameter", + "AllUniversalScreenParameters": "#/components/schemas/QuantAllUniversalScreenParameters" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "FrequencyRoot" + "OneOfQuantFormulasArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OneOfQuantFormulas" } - ] - } - }, - "/analytics/engines/pa/v3/linked-templates": { - "post": { - "tags": [ - "LinkedPATemplates" - ], - "summary": "Create a linked PA template", - "description": "This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.", - "operationId": "createLinkedPATemplates", - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkedPATemplateParametersRoot" - } + }, + "QuantCalculationParameters": { + "type": "object", + "properties": { + "universe": { + "$ref": "#/components/schemas/OneOfQuantUniverse" + }, + "dates": { + "$ref": "#/components/schemas/OneOfQuantDates" + }, + "formulas": { + "$ref": "#/components/schemas/OneOfQuantFormulasArray" + }, + "jobDescription": { + "type": "string" } - }, - "required": true + } }, - "responses": { - "201": { - "description": "Expected response, created a template linked to a PA3 tile.", - "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" - } - } + "QuantCalculationMeta": { + "type": "object", + "properties": { + "allowArrayData": { + "type": "boolean" }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" - } - } + "contentorganization": { + "enum": [ + "None", + "Row", + "Column", + "SimplifiedRow" + ], + "type": "string", + "default": "SimplifiedRow", + "deprecated": true + }, + "stachContentOrganization": { + "enum": [ + "None", + "Row", + "Column", + "SimplifiedRow" + ], + "type": "string", + "default": "SimplifiedRow" + }, + "contenttype": { + "enum": [ + "Json", + "Binary" + ], + "type": "string", + "default": "Json", + "deprecated": true + }, + "format": { + "enum": [ + "JsonStach", + "Table", + "Tableau", + "BinaryStach", + "Bison", + "Binary", + "Pdf", + "Pptx", + "Feather" + ], + "type": "string", + "default": "JsonStach" } - }, - "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" - } + } + }, + "QuantCalculationParametersRoot": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/QuantCalculationParameters" }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } + "description": "List of calculation parameters." }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } + "meta": { + "$ref": "#/components/schemas/QuantCalculationMeta" } - }, - "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." - } - } + } + }, + "SMRetrieveParameters": { + "required": [ + "securityName" + ], + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "location": { + "type": "string" + }, + "asofdate": { + "type": "string" + }, + "securityType": { + "enum": [ + "Bond", + "CCF" + ], + "type": "string" } - }, - "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" - } + } + }, + "SMRetrieveParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMRetrieveParameters" } + }, + "meta": { + "type": "object" } - }, - "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" - } - } + } + }, + "SMCustomCashFlowFields": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SMFields" } - }, - "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" - } + ], + "properties": { + "cashFlowAmounts": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - } - }, - "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" - } + }, + "cashFlowDates": { + "type": "array", + "items": { + "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." - } + }, + "country": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "issueName": { + "type": "string" + }, + "parAmt": { + "type": "number", + "format": "double" + }, + "parentName": { + "type": "string" + }, + "ratingFitch": { + "type": "string" + }, + "ratingFitchDates": { + "type": "array", + "items": { + "type": "string" } - } - }, - "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." - } + }, + "ratingFitchValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "ratingMoodysDates": { + "type": "array", + "items": { + "type": "string" + } + }, + "ratingMoodysValues": { + "type": "array", + "items": { + "type": "string" } + }, + "ratingSpDates": { + "type": "array", + "items": { + "type": "string" + } + }, + "ratingSpValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "secondaryToVendorFlag": { + "type": "boolean" + }, + "sector": { + "type": "string" + }, + "sectorBarclay1": { + "type": "string" + }, + "sectorBarclay2": { + "type": "string" + }, + "sectorBarclay3": { + "type": "string" + }, + "sectorBarclay4": { + "type": "string" + }, + "sectorDef": { + "type": "string" + }, + "sectorIndustry": { + "type": "string" + }, + "sectorMain": { + "type": "string" + }, + "sectorMerrill1": { + "type": "string" + }, + "sectorMerrill2": { + "type": "string" + }, + "sectorMerrill3": { + "type": "string" + }, + "sectorMerrill4": { + "type": "string" + }, + "sectorSubGroup": { + "type": "string" + }, + "vendorCoverageDate": { + "type": "string" } } }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "LinkedPATemplatePostSummaryRoot" - } - ] - }, - "get": { - "tags": [ - "LinkedPATemplates" - ], - "summary": "Get linked PA templates", - "description": "This endpoint returns the list of linked PA templates in given path.", - "operationId": "getLinkedPATemplates", - "parameters": [ - { - "name": "directory", - "in": "query", - "description": "Get linked PA templates in path.", - "schema": { - "type": "string", - "description": "Get linked PA templates in path." - } - }, - { - "name": "documentDirectory", - "in": "query", - "description": "Get linked PA templates for documents in document path", - "schema": { - "type": "string", - "description": "Get linked PA templates for documents in document path" - } - }, - { - "name": "documentName", - "in": "query", - "description": "Get linked PA templates for documents by document name", - "schema": { - "type": "string", - "description": "Get linked PA templates for documents by document name" + "SMFields": { + "required": [ + "securityType" + ], + "type": "object", + "properties": { + "securityType": { + "enum": [ + "Bond", + "CCF" + ], + "type": "string" } } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of templates linked to PA3 tile.", - "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/LinkedPATemplateSummaryRoot" - } - } + }, + "SMBondFields": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SMFields" } - }, - "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" - } + ], + "properties": { + "144aFlag": { + "type": "boolean" + }, + "aperiodicMultipliers": { + "type": "array", + "items": { + "type": "number", + "format": "double" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } + "aperiodicResetDates": { + "type": "array", + "items": { + "type": "string" } - } - }, - "404": { - "description": "Document 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" - } + }, + "aperiodicSpreads": { + "type": "array", + "items": { + "type": "number", + "format": "double" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } + "businessDayConv": { + "type": "string" + }, + "callAnnouncedDate": { + "type": "string" + }, + "callDates": { + "type": "array", + "items": { + "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." - } + }, + "callFreq": { + "type": "string" + }, + "callNoticeDays": { + "type": "integer", + "format": "int32" + }, + "callPrices": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - } - }, - "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" - } + }, + "cashRate": { + "type": "number", + "format": "double" + }, + "cognity": { + "type": "string" + }, + "conversionIdentifier": { + "type": "string" + }, + "conversionRatio": { + "type": "number", + "format": "double" + }, + "conversionType": { + "type": "string" + }, + "convertibleFlag": { + "type": "boolean" + }, + "country": { + "type": "string" + }, + "coupon": { + "type": "number", + "format": "double" + }, + "couponType": { + "type": "string" + }, + "creditSpreadAdjustmentSingle": { + "type": "number", + "format": "double" + }, + "currency": { + "type": "string" + }, + "dayCountBasis": { + "type": "string" + }, + "defaultedDate": { + "type": "string" + }, + "federalTaxExemptFlag": { + "type": "boolean" + }, + "firstPayDate": { + "type": "string" + }, + "firstResetDate": { + "type": "string" + }, + "floatFormula": { + "type": "string" + }, + "fltDayCountBasis": { + "type": "string" + }, + "fltFirstPayDate": { + "type": "string" + }, + "fltPayFreq": { + "type": "string" + }, + "histCouponDates": { + "type": "array", + "items": { + "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" - } + }, + "histCoupons": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - } - }, - "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" - } + }, + "histRcvAssumpDates": { + "type": "array", + "items": { + "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." - } + }, + "histRcvAssumpMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" } - } - }, - "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." - } + }, + "histRcvAssumpRates": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - } - } - }, - "x-are-multiple-success-responses-different": false, - "x-success-response-types": [ - { - "status-code": "200", - "response-type": "LinkedPATemplateSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/linked-templates/{id}": { - "put": { - "tags": [ - "LinkedPATemplates" - ], - "summary": "Update a linked PA template", - "description": "This endpoint allows the user to change the request body and description from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.", - "operationId": "updateLinkedPATemplates", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a linked PA template", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a linked PA template" - } - } - ], - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkedPATemplateUpdateParametersRoot" + }, + "histRcvAssumpTargetDates": { + "type": "array", + "items": { + "type": "string" } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Expected response, updated a template linked to a PA3 tile.", - "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" - } + }, + "inflationType": { + "type": "string" + }, + "issueDate": { + "type": "string" + }, + "issueName": { + "type": "string" + }, + "issuerId": { + "type": "string" + }, + "lastModifiedSource": { + "type": "string" + }, + "lastModifiedSourceMeta": { + "type": "string" + }, + "lastModifiedTime": { + "type": "string" + }, + "lifeCap": { + "type": "number", + "format": "double" + }, + "lifeFloor": { + "type": "number", + "format": "double" + }, + "lockoutDays": { + "type": "integer", + "format": "int32" + }, + "lookBackDays": { + "type": "integer", + "format": "int32" + }, + "makeWholeCallFlag": { + "type": "boolean" + }, + "makeWholeExpireDate": { + "type": "string" + }, + "makeWholeSpread": { + "type": "number", + "format": "double" + }, + "matrixDates": { + "type": "array", + "items": { + "type": "string" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" - } + "matrixMultipliers": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - } - }, - "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" - } + }, + "matrixPricedFlag": { + "type": "boolean" + }, + "matrixSpreads": { + "type": "array", + "items": { + "type": "number", + "format": "double" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } + "matrixUseScheduleFlag": { + "type": "boolean" + }, + "maturityDate": { + "type": "string" + }, + "maturityPrice": { + "type": "number", + "format": "double" + }, + "monthsToRecovery": { + "type": "number", + "format": "double" + }, + "multiplier": { + "type": "number", + "format": "double" + }, + "notionalFlag": { + "type": "boolean" + }, + "observationShift": { + "type": "integer", + "format": "int32" + }, + "origAmtIssued": { + "type": "number", + "format": "double" + }, + "parentName": { + "type": "string" + }, + "parPrice": { + "type": "number", + "format": "double" + }, + "parserInfo": { + "type": "string" + }, + "paymentDelay": { + "type": "integer", + "format": "int32" + }, + "payFreq": { + "type": "string" + }, + "periodCap": { + "type": "number", + "format": "double" + }, + "periodFloor": { + "type": "number", + "format": "double" + }, + "pikExpDate": { + "type": "string" + }, + "pikRate": { + "type": "integer", + "format": "int32" + }, + "preferredSecExDateLen": { + "type": "integer", + "format": "int32" + }, + "preferredSecExDateUnits": { + "type": "string" + }, + "preferredSecFlag": { + "type": "boolean" + }, + "preferredSecType": { + "type": "string" + }, + "principalType": { + "type": "string" + }, + "putDates": { + "type": "array", + "items": { + "type": "string" } - } - }, - "404": { - "description": "Template or 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" - } + }, + "putNoticeDays": { + "type": "integer", + "format": "int32" + }, + "putFreq": { + "type": "string" + }, + "putPrices": { + "type": "array", + "items": { + "type": "number", + "format": "double" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } + "pvtPlacementFlag": { + "type": "boolean" + }, + "ratingFitch": { + "type": "string" + }, + "ratingFitchDates": { + "type": "array", + "items": { + "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" - } - } - } - }, - "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": "LinkedPATemplatePostSummaryRoot" - } - ] - }, - "delete": { - "tags": [ - "LinkedPATemplates" - ], - "summary": "Delete a linked PA template.", - "description": "This endpoint deletes an existing linked PA template.", - "operationId": "deleteLinkedPATemplates", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a linked PA template", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a linked PA template" - } - } - ], - "responses": { - "204": { - "description": "Expected response, deleted the linked PA template 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.", - "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" - } + }, + "ratingFitchValues": { + "type": "array", + "items": { + "type": "string" } }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Template not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } + "ratingMoodysDates": { + "type": "array", + "items": { + "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.", - "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": "204", - "response-type": null - } - ] - }, - "get": { - "tags": [ - "LinkedPATemplates" - ], - "summary": "Get linked PA template by id", - "description": "This endpoint fetches the linked PA template settings.", - "operationId": "getLinkedPATemplatesById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a linked PA template", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a linked PA template" - } - } - ], - "responses": { - "200": { - "description": "Expected response, linked PA template details.", - "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" - } + "ratingMoodysValues": { + "type": "array", + "items": { + "type": "string" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkedPATemplateRoot" - } - } - } - }, - "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" - } + "ratingSpDates": { + "type": "array", + "items": { + "type": "string" } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Template not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } + "ratingSpValues": { + "type": "array", + "items": { + "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": "LinkedPATemplateRoot" - } - ] - } - }, - "/analytics/engines/npo/v3/optimizations": { - "post": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Create and Run NPO optimization", - "description": "This endpoint creates and runs NPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document.", - "operationId": "postAndOptimize", - "parameters": [ - { - "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": "Optimization Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NPOOptimizationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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/CalculationInfoRoot" - } - } - } - }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" - } - } - } - }, - "400": { - "description": "Invalid optimization parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "One or more optimization 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" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/npo/v3/optimizations/{id}": { - "put": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Create or Update NPO optimization and run it.", - "description": "This endpoint updates and run the NPO optimization specified in the PUT body parameters. It also allows the creation of new NPO optimization with custom id.", - "operationId": "putAndOptimize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" - } - }, - { - "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": "Optimization Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NPOOptimizationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting optimization", - "schema": { - "type": "string", - "description": "URL to poll for the resulting optimization" - } - }, - "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/CalculationInfoRoot" - } - } - } - }, - "201": { - "description": "Expected response, returns json if optimization is completed in a short span.", - "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" - } - } - } - }, - "400": { - "description": "Invalid Optimization Parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "One or more optimization 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" - } - } - } - }, - "409": { - "description": "Duplicate optimization exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationInfoRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Get NPO optimization parameters by id", - "description": "This is the endpoint that returns the optimization parameters passed for an optimization.", - "operationId": "getOptimizationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the NPO optimization 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/NPOOptimizationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Optimization 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" - } - } - } - }, - "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": "NPOOptimizationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Cancel NPO optimization by id", - "description": "This is the endpoint to cancel a previously submitted optimization.", - "operationId": "cancelOptimizationById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, optimization was canceled 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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/npo/v3/optimizations/{id}/status": { - "get": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Get NPO optimization status by id", - "description": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getOptimizationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" - } - } - ], - "responses": { - "201": { - "description": "Expected response once optimization is completed, returns 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" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "202": { - "description": "Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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": true, - "x-success-response-types": [ - { - "status-code": "201", - "response-type": "ObjectRoot" - }, - { - "status-code": "202", - "response-type": null - } - ] - } - }, - "/analytics/engines/npo/v3/optimizations/{id}/result": { - "get": { - "tags": [ - "NPO Optimizer" - ], - "summary": "Get NPO optimization result by id", - "description": "This is the endpoint to get the result of a previously requested optimization.", - "operationId": "getOptimizationResult", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once optimization is completed, returns JSON.", - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/calculations": { - "post": { - "tags": [ - "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.", - "operationId": "postAndCalculate", - "parameters": [ - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", - "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/PACalculationParametersRoot" - } - } - } - }, - "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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - } - ] - }, - "get": { - "tags": [ - "PACalculations" - ], - "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.", - "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/CalculationsSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid page number.", - "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": "No calculation 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": "CalculationsSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/calculations/{id}": { - "put": { - "tags": [ - "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.", - "operationId": "putAndCalculate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run PA 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/PACalculationParametersRoot" - } - } - } - }, - "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, 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "PACalculations" - ], - "summary": "Get PA calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the PA 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/PACalculationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation 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" - } - } - } - }, - "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": "PACalculationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "PACalculations" - ], - "summary": "Cancel PA calculation by id", - "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 PA calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, calculation was canceled 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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/pa/v3/calculations/{id}/status": { - "get": { - "tags": [ - "PACalculations" - ], - "summary": "Get PA 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.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getCalculationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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" - } - } - } - }, - "202": { - "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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/pa/v3/calculations/{id}/units/{unitId}/result": { - "get": { - "tags": [ - "PACalculations" - ], - "summary": "Get PA 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 PA calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get PA calculation status by id endpoint" - } - }, - { - "name": "unitId", - "in": "path", - "description": "from url, provided from the location header in the Get PA calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get PA 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/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "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": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/pricing-sources": { - "get": { - "tags": [ - "PricingSources" - ], - "summary": "Get PA pricing sources", - "description": "This endpoint lists all the PA pricing sources that can be applied to a PA calculation.", - "operationId": "getPAPricingSources", - "parameters": [ - { - "name": "name", - "in": "query", - "description": "PA pricing sources name", - "schema": { - "type": "string", - "description": "PA pricing sources name", - "default": "" - } - }, - { - "name": "category", - "in": "query", - "description": "PA pricing sources category", - "schema": { - "type": "string", - "description": "PA pricing sources category", - "default": "" - } - }, - { - "name": "directory", - "in": "query", - "description": "The directory to get the PA pricing sources in", - "schema": { - "type": "string", - "description": "The directory to get the PA pricing sources in", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of PA pricing sources", - "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." - } - }, - "Age": { - "description": "Standard HTTP header. Header will specify the age of pricing sources list cached response.", - "schema": { - "type": "integer", - "description": "Standard HTTP header. Header will specify the age of pricing sources list cached response." - } - }, - "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/PAPricingSourceRoot" - } - } - } - }, - "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": "Pricing sources 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": "PAPricingSourceRoot" - } - ] - } - }, - "/analytics/engines/pub/v3/calculations": { - "post": { - "tags": [ - "PubCalculations" - ], - "summary": "Create and Run Pub calculation", - "description": "This endpoint runs the Pub calculation specified in the POST body parameters.\r\nIt can take one or more units as input.", - "operationId": "postAndCalculate", - "parameters": [ - { - "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.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Calculation Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PubCalculationParametersRoot" - } - } - } - }, - "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/pdf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - } - } - }, - "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/pdf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "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/pdf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "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-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/pdf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "One or more calculation settings were unavailable.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/pdf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": null, - "is-file": true - } - ] - }, - "get": { - "tags": [ - "PubCalculations" - ], - "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.", - "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/CalculationsSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid page number.", - "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": "No calculation 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": "CalculationsSummaryRoot" - } - ] - } - }, - "/analytics/engines/pub/v3/calculations/{id}": { - "put": { - "tags": [ - "PubCalculations" - ], - "summary": "Create or Update Pub calculation and run it.", - "description": "This endpoint updates and run the Pub calculation specified in the PUT body parameters. This also allows creating new Pub calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", - "operationId": "putAndCalculate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Pub 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/PubCalculationParametersRoot" - } - } - } - }, - "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/pdf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - } - } - }, - "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-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/pdf": { - "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-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/pdf": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "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/pdf": { - "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/pdf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-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/pdf": { - "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": { - "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-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" - } - } - } - }, - "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-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" - } - }, - "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." - } - }, - "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." - } - } - } - }, - "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-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-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": null, - "is-file": true - } - ] - }, - "get": { - "tags": [ - "PubCalculations" - ], - "summary": "Get Pub calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the Pub 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/PubCalculationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation 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" - } - } - } - }, - "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": "PubCalculationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "PubCalculations" - ], - "summary": "Cancel Pub calculation by id", - "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 Pub calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, calculation was canceled 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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/pub/v3/calculations/{id}/status": { - "get": { - "tags": [ - "PubCalculations" - ], - "summary": "Get Pub 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", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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" - } - } - } - }, - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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/pub/v3/calculations/{id}/units/{unitId}/result": { - "get": { - "tags": [ - "PubCalculations" - ], - "summary": "Get Pub 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 the specified format.", - "operationId": "getCalculationUnitResultById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" - } - }, - { - "name": "unitId", - "in": "path", - "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed, returns result in the format specified in the Calculation parameters.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "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": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/pdf": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/pdf": { - "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" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/pdf": { - "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": null, - "is-file": true - } - ] - } - }, - "/analytics/engines/quant/v3/calculations": { - "post": { - "tags": [ - "QuantCalculations" - ], - "summary": "Create and Run Quant Engine calculation", - "description": "This endpoint runs the Quant Engine calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input.", - "operationId": "postAndCalculate", - "parameters": [ - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts no-store, max-age, max-stale.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuantCalculationParametersRoot" - } - } - } - }, - "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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - } - ] - }, - "get": { - "tags": [ - "QuantCalculations" - ], - "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.", - "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/CalculationsSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid page number.", - "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": "No calculation 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": "CalculationsSummaryRoot" - } - ] - } - }, - "/analytics/engines/quant/v3/calculations/{id}": { - "put": { - "tags": [ - "QuantCalculations" - ], - "summary": "Create or update Quant Engine calculation and run it.", - "description": "This endpoint updates and runs the Quant Engine calculation specified in the PUT body parameters. This also allows creating new Quant Engine calculations with custom ids.\r\nIt can take one or more calculation units as input.", - "operationId": "putAndCalculate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" - } - }, - { - "name": "Cache-Control", - "in": "header", - "description": "Standard HTTP header. Accepts no-store, max-age, max-stale.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Calculation Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuantCalculationParametersRoot" - } - } - } - }, - "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 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "QuantCalculations" - ], - "summary": "Get Quant Engine calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the Quant Engine calculation parameters.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuantCalculationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "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": "Calculation 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" - } - } - } - }, - "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": "QuantCalculationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "QuantCalculations" - ], - "summary": "Cancel Quant calculation by id", - "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 Quant calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Quant calculation endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, calculation was canceled 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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/quant/v3/calculations/{id}/status": { - "get": { - "tags": [ - "QuantCalculations" - ], - "summary": "Get Quant Engine 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.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.", - "operationId": "getCalculationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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" - } - } - } - }, - "202": { - "description": "Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header.", - "headers": { - "X-FactSet-Api-PickUp-Progress": { - "description": "FactSet's progress header.", - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "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", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "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", - "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": null, - "is-file": true - } - ] - } - }, - "/analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info": { - "get": { - "tags": [ - "QuantCalculations" - ], - "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 calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "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 calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "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.", - "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": { - "type": "string", - "format": "binary" - } - }, - "application/x-protobuf": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "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", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "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", - "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": null, - "is-file": true - } - ] - } - }, - "/analytics/engines/spar/v3/calculations": { - "post": { - "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", - "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.", - "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": { - "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, 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "SPARCalculations" - ], - "summary": "Get 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.", - "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/CalculationsSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid page number.", - "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": "No calculation 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": "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" - } - }, - { - "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": { - "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, 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "SPARCalculations" - ], - "summary": "Get SPAR calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the SPAR calculation parameters.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SPARCalculationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation 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" - } - } - } - }, - "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": "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.", - "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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/spar/v3/calculations/{id}/status": { - "get": { - "tags": [ - "SPARCalculations" - ], - "summary": "Get SPAR calculation status by id", - "description": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.", - "operationId": "getCalculationStatusById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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" - } - } - } - }, - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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/spar/v3/calculations/{id}/units/{unitId}/result": { - "get": { - "tags": [ - "SPARCalculations" - ], - "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 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", - "in": "path", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed, 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.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "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": "ObjectRoot" - } - ] - } - }, - "/analytics/engines/axp/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", - "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": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of Axioma Equity strategy 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", - "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", - "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 some time", - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/afi/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", - "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": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of Axioma FI strategy 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", - "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", - "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 some time", - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/bpm/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", - "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": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of Barra strategy 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", - "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", - "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 some time", - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/npo/v3/strategies/{path}": { - "get": { - "tags": [ - "StrategyDocuments" - ], - "summary": "Get Northfield strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all Northfield strategy documents and sub-directories in a given directory.", - "operationId": "getNorthfieldStrategyDocuments", - "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": "" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns a list of Northfield strategy 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", - "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", - "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 some time", - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/fpo/v3/strategies/{path}": { - "get": { - "tags": [ - "StrategyDocuments" - ], - "summary": "Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory", - "description": "This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory.", - "operationId": "getFPOStrategyDocuments", - "parameters": [ - { - "name": "path", - "in": "path", - "description": "The directory to get the strategy documents and sub-directories in", - "required": true, - "schema": { - "type": "string", - "description": "The directory to get the strategy documents and sub-directories in", - "default": "" - } - } - ], - "responses": { - "200": { - "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.", - "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", - "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", - "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 some time", - "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": "DocumentDirectoriesRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/templated-components": { - "post": { - "tags": [ - "TemplatedPAComponents" - ], - "summary": "Create templated PA component", - "description": "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", - "operationId": "createTemplatedPAComponents", - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentParametersRoot" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Expected response, templated PA component created 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" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" - } - }, - "text/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": { - "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.", - "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": "Template not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "406": { - "description": "Unsupported Accept header. Header needs to be set to application/json.", - "headers": { - "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": "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.", - "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/TemplatedPAComponentSummaryRoot" - } - } - } - }, - "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" - } - } - } - }, - "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": "TemplatedPAComponentSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/templated-components/{id}": { - "put": { - "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", - "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/TemplatedPAComponentUpdateParametersRoot" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Expected response, updated 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" - } - } - }, - "content": { - "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/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." - } - }, - "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": "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.", - "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/TemplatedPAComponentRoot" - } - } - } - }, - "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": "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": { - "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": "TemplatedPAComponentRoot" - } - ] - }, - "delete": { - "tags": [ - "TemplatedPAComponents" - ], - "summary": "Delete templated PA component", - "description": "This endpoint deletes an existing templated PA component", - "operationId": "deleteTemplatedPAComponents", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for a templated PA component", - "required": true, - "schema": { - "type": "string", - "description": "Unique identifier for a templated PA component" - } - } - ], - "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.", - "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": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates": { - "post": { - "tags": [ - "UnlinkedPATemplates" - ], - "summary": "Create unlinked PA template", - "description": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also \r\n overriding the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component.", - "operationId": "createUnlinkedPATemplates", - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" - } - } - }, - "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.", - "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": "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.", - "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/UnlinkedPATemplateSummaryRoot" - } - } - } - }, - "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" - } - } - } - }, - "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": "UnlinkedPATemplateSummaryRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates/{id}": { - "put": { - "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", - "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/UnlinkedPATemplateUpdateParametersRoot" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Expected response, updated 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/UnlinkedPATemplatePostSummaryRoot" - } - } - } - }, - "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.", - "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": "UnlinkedPATemplatePostSummaryRoot" - } - ] - }, - "delete": { - "tags": [ - "UnlinkedPATemplates" - ], - "summary": "Delete unlinked PA template", - "description": "This endpoint deletes an existing unliked PA template.", - "operationId": "deleteUnlinkedPATemplates", - "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" - } - } - ], - "responses": { - "204": { - "description": "Expected response, deleted the unlinked PA template 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.", - "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.", - "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": "204", - "response-type": null - } - ] - }, - "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" - } - } - ], - "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.", - "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": "UnlinkedPATemplateRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates/template-types": { - "get": { - "tags": [ - "UnlinkedPATemplates" - ], - "summary": "Get default unlinked PA template types.", - "description": "This endpoint fetches default unlinked PA template types.", - "operationId": "getDefaultUnlinkedPATemplateTypes", - "responses": { - "200": { - "description": "Expected response, default unlinked PA template types", - "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/UnlinkedPATemplateCategoryAndTypeRoot" - } - } - } - }, - "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": "UnlinkedPATemplateCategoryAndTypeRoot" - } - ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}": { - "get": { - "tags": [ - "UnlinkedPATemplates" - ], - "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, details of the unlinked PA template type", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" - } - } - } - }, - "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" - } - } - } - }, - "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/calculations": { - "post": { - "tags": [ - "VaultCalculations" - ], - "summary": "Create and Run Vault calculation", - "description": "This endpoint runs the Vault calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", - "operationId": "postAndCalculate", - "parameters": [ - { - "name": "X-FactSet-Api-Long-Running-Deadline", - "in": "header", - "description": "Long running deadline in seconds when only one unit is passed in the POST body.", - "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/VaultCalculationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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, 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "VaultCalculations" - ], - "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.", - "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/CalculationsSummaryRoot" - } - } - } - }, - "400": { - "description": "Invalid page number.", - "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": "No calculation 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": "CalculationsSummaryRoot" - } - ] - } - }, - "/analytics/engines/vault/v3/calculations/{id}": { - "put": { - "tags": [ - "VaultCalculations" - ], - "summary": "Create or Update Vault calculation and run it.", - "description": "This endpoint updates and run the Vault calculation specified in the PUT body parameters. This also allows creating new Vault calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range", - "operationId": "putAndCalculate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Vault 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/VaultCalculationParametersRoot" - } - } - } - }, - "responses": { - "202": { - "description": "Expected response, contains the poll URL in the Location header.", - "headers": { - "Location": { - "description": "URL to poll for the resulting calculation", - "schema": { - "type": "string", - "description": "URL to poll for the resulting calculation" - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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, 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": { - "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" - } - } - } - }, - "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-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-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "409": { - "description": "Duplicate calculation exists with same parameters.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - }, - "Retry-After": { - "description": "Time to wait in seconds before making a new request as the rate limit has reached.", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - } - }, - "x-are-multiple-success-responses-different": true, - "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" - } - ] - }, - "get": { - "tags": [ - "VaultCalculations" - ], - "summary": "Get Vault calculation parameters by id", - "description": "This is the endpoint that returns the calculation parameters passed for a calculation.", - "operationId": "getCalculationParameters", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response, returns the Vault 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/VaultCalculationParametersRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation 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" - } - } - } - }, - "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": "VaultCalculationParametersRoot" - } - ] - }, - "delete": { - "tags": [ - "VaultCalculations" - ], - "summary": "Cancel Vault calculation by id", - "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 Vault calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" - } - } - ], - "responses": { - "204": { - "description": "Expected response, calculation was canceled 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 identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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.", - "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": { - "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.", - "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": "204", - "response-type": null - } - ] - } - }, - "/analytics/engines/vault/v3/calculations/{id}/status": { - "get": { - "tags": [ - "VaultCalculations" - ], - "summary": "Get Vault 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", - "in": "path", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" - } - } - ], - "responses": { - "200": { - "description": "Expected response once calculation is completed.", - "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header." - } - }, - "Content-Type": { - "description": "Standard HTTP header.", - "schema": { - "type": "string", - "description": "Standard HTTP header." - } - }, - "Transfer-Encoding": { - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.", - "schema": { - "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." - } - }, - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "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" - } - } - } - }, - "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" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "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/vault/v3/calculations/{id}/units/{unitId}/result": { - "get": { - "tags": [ - "VaultCalculations" - ], - "summary": "Get Vault 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 Vault calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint" - } - }, - { - "name": "unitId", - "in": "path", - "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint", - "required": true, - "schema": { - "type": "string", - "description": "from url, provided from the location header in the Get Vault 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/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - } - } - }, - "400": { - "description": "Invalid identifier provided.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "404": { - "description": "Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, - "401": { - "description": "Missing or invalid authentication.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - } - } - }, - "403": { - "description": "User is forbidden with current credentials", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - } - }, - "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": "ObjectRoot" - } - ] - } - } - }, - "components": { - "schemas": { - "ReturnType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "additionalProperties": false - }, - "SPARAccounts": { - "type": "object", - "properties": { - "returnsType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReturnType" - }, - "description": "List of SPAR returnsType" - } - }, - "additionalProperties": false - }, - "SPARAccountsRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SPARAccounts" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ErrorSource": { - "type": "object", - "properties": { - "pointer": { - "type": "string" - }, - "parameter": { - "type": "string" - } - }, - "additionalProperties": false - }, - "Error": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "detail": { - "type": "string" - }, - "source": { - "$ref": "#/components/schemas/ErrorSource" - } - }, - "additionalProperties": false - }, - "ClientErrorResponse": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" - } - } - }, - "additionalProperties": false - }, - "AccountDirectories": { - "type": "object", - "properties": { - "accounts": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of account and composite files." - }, - "directories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of directories." - } - }, - "additionalProperties": false - }, - "AccountDirectoriesRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AccountDirectories" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "AFIOptimizerStrategyOverrides": { - "type": "object", - "properties": { - "objective": { - "type": "string", - "description": "Objective" - }, - "tax": { - "type": "string", - "description": "Tax" - }, - "constraints": { - "type": "object", - "additionalProperties": { - "enum": [ - "Disable", - "Enable" - ], - "type": "string" - }, - "description": "List of constraints" - }, - "alpha": { - "type": "string", - "description": "Alpha" - }, - "transactionCost": { - "type": "string", - "description": "Transaction cost" - } - }, - "additionalProperties": false - }, - "AFIOptimizerStrategy": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "overrides": { - "$ref": "#/components/schemas/AFIOptimizerStrategyOverrides" - }, - "id": { - "type": "string", - "description": "OptimizerStrategy document path" - } - }, - "additionalProperties": false - }, - "OptimizerAccountOverrides": { - "type": "object", - "properties": { - "portfolio": { - "type": "string", - "description": "Portfolio" - }, - "benchmark": { - "type": "string", - "description": "Benchmark" - }, - "riskModelId": { - "type": "string", - "description": "Risk model" - }, - "currency": { - "type": "string", - "description": "Currency" - } - }, - "additionalProperties": false - }, - "OptimizerAccount": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Account path" - }, - "overrides": { - "$ref": "#/components/schemas/OptimizerAccountOverrides" - } - }, - "additionalProperties": false - }, - "Optimization": { - "type": "object", - "properties": { - "riskModelDate": { - "type": "string", - "description": "Risk model date" - }, - "backtestDate": { - "type": "string", - "description": "Backtest date" - }, - "cashflow": { - "type": "string", - "description": "Cash flow" - } - }, - "additionalProperties": false - }, - "OptimizerTradesList": { - "type": "object", - "properties": { - "identifierType": { - "enum": [ - "Asset", - "Cusip", - "Isin", - "RiskModel", - "SedolChk", - "Sedol", - "SymbologyCusip", - "Ticker", - "TickerRegion", - "User" - ], - "type": "string", - "description": "Identifier type" - }, - "includeCash": { - "type": "boolean", - "description": "Include cash" - } - }, - "additionalProperties": false - }, - "OptimizerOptimalHoldings": { - "type": "object", - "properties": { - "identifierType": { - "enum": [ - "Asset", - "Cusip", - "Isin", - "RiskModel", - "SedolChk", - "Sedol", - "SymbologyCusip", - "Ticker", - "TickerRegion", - "User" - ], - "type": "string", - "description": "Identifier type" - }, - "includeCash": { - "type": "boolean", - "description": "Include cash" - }, - "excludeZero": { - "type": "boolean", - "description": "Exclude zero" - } - }, - "additionalProperties": false - }, - "OptimalPortfolio": { - "type": "object", - "properties": { - "acctName": { - "type": "string", - "description": "Account path" - }, - "excludeZero": { - "type": "boolean", - "description": "Exclude zero" - }, - "archiveDate": { - "type": "string", - "description": "Archive date" - }, - "ifAcctExists": { - "enum": [ - "abort", - "overwrite", - "appendDate" - ], - "type": "string", - "description": "Archive action if account exists" - }, - "ifOfdbDateExists": { - "enum": [ - "abort", - "replaceDate", - "appendSecurities" - ], - "type": "string", - "description": "Action if ofdb date exists" - } - }, - "additionalProperties": false - }, - "OptimizerStats": { - "type": "object", - "additionalProperties": false - }, - "OptimizerOutputTypes": { - "type": "object", - "properties": { - "trades": { - "$ref": "#/components/schemas/OptimizerTradesList" - }, - "optimal": { - "$ref": "#/components/schemas/OptimizerOptimalHoldings" - }, - "account": { - "$ref": "#/components/schemas/OptimalPortfolio" - }, - "stats": { - "$ref": "#/components/schemas/OptimizerStats" - } - }, - "additionalProperties": false - }, - "AFIOptimizationParameters": { - "required": [ - "outputTypes", - "strategy" - ], - "type": "object", - "properties": { - "strategy": { - "$ref": "#/components/schemas/AFIOptimizerStrategy" - }, - "account": { - "$ref": "#/components/schemas/OptimizerAccount" - }, - "optimization": { - "$ref": "#/components/schemas/Optimization" - }, - "outputTypes": { - "$ref": "#/components/schemas/OptimizerOutputTypes" - } - }, - "additionalProperties": false - }, - "OptimizerCalculationMeta": { - "type": "object", - "additionalProperties": false - }, - "AFIOptimizationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AFIOptimizationParameters" - }, - "meta": { - "$ref": "#/components/schemas/OptimizerCalculationMeta" - } - }, - "additionalProperties": false - }, - "CalculationInfo": { - "type": "object", - "properties": { - "calculationId": { - "type": "string", - "description": "Calculation identifier" - } - }, - "additionalProperties": false - }, - "CalculationInfoRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CalculationInfo" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ObjectRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "AxiomaEquityOptimizerStrategyOverrides": { - "type": "object", - "properties": { - "objective": { - "type": "string", - "description": "Objective" - }, - "tax": { - "type": "string", - "description": "Tax" - }, - "constraints": { - "type": "object", - "additionalProperties": { - "enum": [ - "Disable", - "Enable" - ], - "type": "string" - }, - "description": "List of constraints" - }, - "alpha": { - "type": "string", - "description": "Alpha" - }, - "transactionCost": { - "type": "string", - "description": "Transaction cost" - } - }, - "additionalProperties": false - }, - "AxiomaEquityOptimizerStrategy": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "overrides": { - "$ref": "#/components/schemas/AxiomaEquityOptimizerStrategyOverrides" - }, - "id": { - "type": "string", - "description": "OptimizerStrategy document path" - } - }, - "additionalProperties": false - }, - "AxiomaEquityOptimizationParameters": { - "required": [ - "outputTypes", - "strategy" - ], - "type": "object", - "properties": { - "strategy": { - "$ref": "#/components/schemas/AxiomaEquityOptimizerStrategy" - }, - "account": { - "$ref": "#/components/schemas/OptimizerAccount" - }, - "optimization": { - "$ref": "#/components/schemas/Optimization" - }, - "outputTypes": { - "$ref": "#/components/schemas/OptimizerOutputTypes" - } - }, - "additionalProperties": false - }, - "AxiomaEquityOptimizationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AxiomaEquityOptimizationParameters" - }, - "meta": { - "$ref": "#/components/schemas/OptimizerCalculationMeta" - } - }, - "additionalProperties": false - }, - "SPARIdentifier": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "User's FactSet account OR benchmark id." - }, - "returntype": { - "type": "string", - "description": "Benchmark return type." - }, - "prefix": { - "type": "string", - "description": "Benchmark prefix." - } - }, - "additionalProperties": false, - "description": "The account/benchmark parameter for SPAR calculation." - }, - "SPARBenchmark": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Benchmark identifier" - }, - "name": { - "type": "string", - "description": "Benchmark Name" - }, - "identifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SPARIdentifier" - }, - "description": "List of SPAR identifiers" - } - }, - "additionalProperties": false - }, - "SPARBenchmarkRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SPARBenchmark" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ConstraintAction": { - "type": "object", - "properties": { - "item1": { - "type": "string" - }, - "item2": { - "enum": [ - "Disable", - "Enable" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "BPMOptimizerStrategyAlphaOverride": { - "type": "object", - "properties": { - "formula": { - "type": "string" - }, - "returnType": { - "enum": [ - "Excess", - "Total", - "Active", - "Residual", - "Exceptional" - ], - "type": "string" - }, - "returnMultiplier": { - "type": "string" - } - }, - "additionalProperties": false - }, - "BPMOptimizerStrategyOverrides": { - "type": "object", - "properties": { - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstraintAction" - }, - "description": "List of constraints" - }, - "alpha": { - "$ref": "#/components/schemas/BPMOptimizerStrategyAlphaOverride" - }, - "tax": { - "type": "string", - "description": "Tax\r\nCan be set to \"\" for local" - }, - "transactionCost": { - "type": "string", - "description": "Transaction cost\r\nCan be set to \"\" for local" - } - }, - "additionalProperties": false - }, - "BPMOptimizerStrategy": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "overrides": { - "$ref": "#/components/schemas/BPMOptimizerStrategyOverrides" - }, - "id": { - "type": "string", - "description": "OptimizerStrategy document path" - } - }, - "additionalProperties": false - }, - "BPMOptimization": { - "type": "object", - "properties": { - "market": { - "type": "string", - "description": "Optimization market" - }, - "investAllCash": { - "type": "boolean", - "description": "Optimization invest all cash" - }, - "riskModelDate": { - "type": "string", - "description": "Risk model date" - }, - "backtestDate": { - "type": "string", - "description": "Backtest date" - }, - "cashflow": { - "type": "string", - "description": "Cash flow" - } - }, - "additionalProperties": false - }, - "BPMOptimizationParameters": { - "required": [ - "outputTypes", - "strategy" - ], - "type": "object", - "properties": { - "strategy": { - "$ref": "#/components/schemas/BPMOptimizerStrategy" - }, - "optimization": { - "$ref": "#/components/schemas/BPMOptimization" - }, - "account": { - "$ref": "#/components/schemas/OptimizerAccount" - }, - "outputTypes": { - "$ref": "#/components/schemas/OptimizerOutputTypes" - } - }, - "additionalProperties": false - }, - "BPMOptimizationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/BPMOptimizationParameters" - }, - "meta": { - "$ref": "#/components/schemas/OptimizerCalculationMeta" - } - }, - "additionalProperties": false - }, - "ColumnSummary": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Column Name" - }, - "directory": { - "type": "string", - "description": "Column Directory" - }, - "category": { - "type": "string", - "description": "Column Category" - } - }, - "additionalProperties": false, - "description": "Column settings (name, directory, category)" - }, - "ColumnSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ColumnSummary" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "Column": { - "type": "object", - "properties": { - "defaultstatisticsids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Column statistic Id" - }, - "name": { - "type": "string", - "description": "Column Name" - }, - "directory": { - "type": "string", - "description": "Column Directory" - }, - "category": { - "type": "string", - "description": "Column Category" - } - }, - "additionalProperties": false - }, - "ColumnRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Column" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ColumnStatistic": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Column Statistic Name" - } - }, - "additionalProperties": false - }, - "ColumnStatisticRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ColumnStatistic" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ComponentSummary": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Component name." - }, - "category": { - "type": "string", - "description": "Component category." - } - }, - "additionalProperties": false - }, - "ComponentSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ComponentSummary" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "PAIdentifier": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "User's FactSet account path OR benchmark." - }, - "holdingsmode": { - "type": "string", - "description": "Holdings Mode can be B&H, TBR, OMS or EXT." - } - }, - "additionalProperties": false - }, - "PADateParameters": { - "required": [ - "enddate", - "frequency" - ], - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." - }, - "enddate": { - "type": "string", - "description": "Calculation's end date." - }, - "frequency": { - "type": "string", - "description": "Calculation's frequency." - } - }, - "additionalProperties": false, - "description": "The date parameters for PA calculation." - }, - "PAComponent": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Component identifier." - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" - }, - "description": "List of accounts saved in the PA document." - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" - }, - "description": "List of benchmarks saved in the PA document." - }, - "currencyisocode": { - "type": "string" - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "snapshot": { - "type": "boolean", - "description": "Is the component type snapshot or subperiod." - }, - "path": { - "type": "string", - "description": "The path to the document" - }, - "name": { - "type": "string", - "description": "Component name." - }, - "category": { - "type": "string", - "description": "Component category." - } - }, - "additionalProperties": false - }, - "PAComponentRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PAComponent" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "VaultIdentifier": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "User's FactSet account path OR benchmark." - } - }, - "additionalProperties": false, - "description": "The account/benchmark parameter for Vault calculation." - }, - "VaultDateParameters": { - "required": [ - "enddate", - "frequency" - ], - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." - }, - "enddate": { - "type": "string", - "description": "Calculation's end date." - }, - "frequency": { - "type": "string", - "description": "Calculation's frequency." - } - }, - "additionalProperties": false, - "description": "The date parameters for Vault calculation" - }, - "VaultComponent": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Vault component identifier" - }, - "account": { - "$ref": "#/components/schemas/VaultIdentifier" - }, - "benchmark": { - "$ref": "#/components/schemas/VaultIdentifier" - }, - "currencyisocode": { - "type": "string", - "description": "Currency iso code saved in the document" - }, - "dates": { - "$ref": "#/components/schemas/VaultDateParameters" - }, - "snapshot": { - "type": "boolean", - "description": "Snapshot" - }, - "path": { - "type": "string", - "description": "The path to the document" - }, - "name": { - "type": "string", - "description": "Component name." - }, - "category": { - "type": "string", - "description": "Component category." - } - }, - "additionalProperties": false - }, - "VaultComponentRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/VaultComponent" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "VaultConfigurationSummary": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Configuration name." - } - }, - "additionalProperties": false - }, - "VaultConfigurationSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/VaultConfigurationSummary" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "ConfigurationAccount": { - "type": "object", - "properties": { - "benchmarkCode": { - "type": "string", - "description": "Benchmark code." - }, - "benchmarkName": { - "type": "string", - "description": "Benchmark name." - }, - "maxEndDate": { - "type": "string", - "description": "Maximum end date." - }, - "minStartDate": { - "type": "string", - "description": "Minimum start date." - }, - "lockingDate": { - "type": "string", - "description": "Locking date." - }, - "name": { - "type": "string", - "description": "Account name." - } - }, - "additionalProperties": false - }, - "VaultConfiguration": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Configuration name." - }, - "accounts": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ConfigurationAccount" - } - } - }, - "additionalProperties": false - }, - "VaultConfigurationRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/VaultConfiguration" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "Currency": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of currency." - } - }, - "additionalProperties": false - }, - "CurrencyRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Currency" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "DateParametersSummary": { - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Start date in YYYYMMDD format." - }, - "enddate": { - "type": "string", - "description": "End date in YYYYMMDD format." - } - }, - "additionalProperties": false - }, - "DateParametersSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DateParametersSummary" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "FIDiscountCurveInfo": { - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "name": { - "type": "string" - }, - "currency": { - "type": "string" - } - }, - "additionalProperties": false - }, - "FIDiscountCurveInfoRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/FIDiscountCurveInfo" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "DocumentDirectories": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of documents" - }, - "directories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of directories." - } - }, - "additionalProperties": false - }, - "DocumentDirectoriesRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentDirectories" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "FIABIdentifier": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "User's FactSet account path." - } - }, - "additionalProperties": false - }, - "FIABDateParameters": { - "required": [ - "enddate", - "startdate" - ], - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." - }, - "enddate": { - "type": "string", - "description": "Calculation's end date." - } - }, - "additionalProperties": false, - "description": "The date parameters for FIAB calculations." - }, - "FIABCalculationParameters": { - "required": [ - "account", - "dates" - ], - "type": "object", - "properties": { - "fiabdocument": { - "type": "string", - "description": "FiabDocument (optional) - FIAB document to use as a template. Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" - }, - "account": { - "$ref": "#/components/schemas/FIABIdentifier" - }, - "dates": { - "$ref": "#/components/schemas/FIABDateParameters" - }, - "msl": { - "type": "string", - "description": "Master FISecurity List. Analytics results will be written to the selected MSL. Expects a GUI-style path (Client:/foo/bar)" - }, - "fisettingsdocument": { - "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", - "properties": { - "requesttime": { - "type": "string", - "description": "Request time of calculation.", - "format": "date-time" - }, - "lastpolltime": { - "type": "string", - "description": "Last poll time of calculation.", - "format": "date-time" - } - }, - "additionalProperties": false - }, - "EventSummary": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Event's message" - }, - "submissiondatetime": { - "type": "string", - "description": "Event's submission time", - "format": "date-time" - }, - "type": { - "type": "string", - "description": "Event's type" - } - }, - "additionalProperties": false - }, - "FIABCalculationStatus": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Calculation's identifier" - }, - "status": { - "enum": [ - "Pending", - "InProgress", - "Done", - "Paused", - "Cancelled", - "Error" - ], - "type": "string", - "description": "Calculation's status" - }, - "startdatetime": { - "type": "string", - "description": "Start time", - "format": "date-time" - }, - "completiondatetime": { - "type": "string", - "description": "Completion time", - "format": "date-time" - }, - "progress": { - "type": "integer", - "description": "Calculation's progress", - "format": "int32" - }, - "batchevents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventSummary" - }, - "description": "List of batch events" - } - }, - "additionalProperties": false - }, - "FIReferencePrepay": { - "type": "object", - "properties": { - "prepayName": { - "type": "string", - "description": "Reference Prepay Name" - } - }, - "additionalProperties": false - }, - "FIReferenceSecurity": { - "type": "object", - "properties": { - "securityType": { - "type": "string", - "description": "Reference Security Type" - }, - "securityName": { - "type": "string", - "description": "Reference Security Name" - }, - "calcFromMethod": { - "type": "string", - "description": "Reference Calculation Method.\r\nMethods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,\r\nYield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" - }, - "calcFromValue": { - "type": "number", - "description": "Reference CalcFromValue", - "format": "double" - }, - "prepay": { - "$ref": "#/components/schemas/FIReferencePrepay" - }, - "settlement": { - "type": "string", - "description": "Reference Settlement Date" - } - }, - "additionalProperties": false - }, - "FIBankLoans": { - "type": "object", - "properties": { - "ignoreSinkingFund": { - "type": "boolean", - "description": "Ignore Sinking Fund" - } - }, - "additionalProperties": false - }, - "FIMunicipalBonds": { - "type": "object", - "properties": { - "ignoreSinkingFund": { - "type": "boolean", - "description": "Ignore Sinking Fund Schedule" - }, - "useAnticipatedSinkSchedule": { - "type": "boolean", - "description": "Anticipate Sink Schedule" - } - }, - "additionalProperties": false - }, - "FILoss": { - "type": "object", - "properties": { - "lossName": { - "type": "string", - "description": "Loss Name" - } - }, - "additionalProperties": false - }, - "FIPrepay": { - "type": "object", - "properties": { - "prepayName": { - "type": "string", - "description": "Prepay Name" - } - }, - "additionalProperties": false - }, - "FIServicerAdvancesForSecurities": { - "type": "object", - "properties": { - "principal": { - "type": "number", - "description": "Principal", - "format": "double" - }, - "interest": { - "type": "number", - "description": "Interest", - "format": "double" - }, - "advanceType": { - "enum": [ - "Advances All", - "Advances All But Newly Liqdtd", - "Does Not Advance", - "Principal Only", - "Interest Only" - ], - "type": "string", - "description": "Advance Type" - } - }, - "additionalProperties": false - }, - "FIPrepayLockout": { - "type": "object", - "properties": { - "pointsAbove": { - "enum": [ - "ANY", - "NO_LOCKOUT", - "NUMERIC" - ], - "type": "string", - "description": "Points Above" - }, - "ymAbove": { - "enum": [ - "ANY", - "NO_LOCKOUT", - "NUMERIC" - ], - "type": "string", - "description": "Ym Above" - } - }, - "additionalProperties": false - }, - "FICashflows": { - "type": "object", - "properties": { - "optionalRedemptionCallWhenUnits": { - "enum": [ - "Manual", - "Never", - "ASAP", - "Date", - "Deal Closing", - "Settle Date" - ], - "type": "string", - "description": "OptionalRedemptionCallWhenUnits" - }, - "optionalRedemptionCallWhen": { - "type": "integer", - "description": "OptionalRedemptionCallWhen", - "format": "int32" - }, - "recoveryLag": { - "type": "integer", - "description": "RecoveryLag", - "format": "int32" - } - }, - "additionalProperties": false - }, - "FIBalloonExtension": { - "type": "object", - "properties": { - "months": { - "type": "integer", - "description": "Months", - "format": "int32" - }, - "percentage": { - "type": "number", - "description": "Percentage", - "format": "double" - }, - "amortizationType": { - "enum": [ - "Loan_Amort_None", - "Loan_Amort_Regular", - "Loan_Amort_Default" - ], - "type": "string", - "description": "Amortization Type" - }, - "units": { - "type": "string", - "description": "Units" - }, - "couponStepup": { - "type": "number", - "description": "Coupon Stepup", - "format": "double" - } - }, - "additionalProperties": false - }, - "FIStructuredProductsForSecurities": { - "type": "object", - "properties": { - "servicerAdvances": { - "$ref": "#/components/schemas/FIServicerAdvancesForSecurities" - }, - "ignoreFinancialGuarantee": { - "type": "string", - "description": "Ignore Financial Guarantee" - }, - "cleanUpCallMethod": { - "type": "boolean", - "description": "Cleanup Call Method" - }, - "doOPTRedeem": { - "type": "string", - "description": "Do OPT Redeem" - }, - "prepayLockout": { - "$ref": "#/components/schemas/FIPrepayLockout" - }, - "cashflows": { - "$ref": "#/components/schemas/FICashflows" - }, - "balloonExtension": { - "$ref": "#/components/schemas/FIBalloonExtension" - } - }, - "additionalProperties": false - }, - "FISecurity": { - "required": [ - "calcFromValue", - "symbol" - ], - "type": "object", - "properties": { - "settlement": { - "type": "string", - "description": "Settlement date" - }, - "callMethod": { - "enum": [ - "No Call", - "Intrinsic Value", - "First Call", - "First Par" - ], - "type": "string", - "description": "Call Method" - }, - "referenceSecurity": { - "$ref": "#/components/schemas/FIReferenceSecurity" - }, - "bankLoans": { - "$ref": "#/components/schemas/FIBankLoans" - }, - "municipalBonds": { - "$ref": "#/components/schemas/FIMunicipalBonds" - }, - "loss": { - "$ref": "#/components/schemas/FILoss" - }, - "prepay": { - "$ref": "#/components/schemas/FIPrepay" - }, - "matrixSpreadAdjustment": { - "type": "number", - "description": "Matrix Spread Adjustment", - "format": "double" - }, - "matrixMultiplier": { - "type": "number", - "description": "Matrix Multiplier", - "format": "double" - }, - "structuredProducts": { - "$ref": "#/components/schemas/FIStructuredProductsForSecurities" - }, - "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" - }, - "calcFromValue": { - "type": "number", - "description": "Calculation from value", - "format": "double" - }, - "face": { - "type": "number", - "description": "Face", - "format": "double", - "default": 1 - }, - "faceType": { - "enum": [ - "Current", - "Original" - ], - "type": "string", - "description": "Face type", - "default": "Current" - }, - "symbol": { - "type": "string", - "description": "Symbol" - }, - "discountCurve": { - "type": "string", - "description": "Discount curve" - } - }, - "additionalProperties": false - }, - "FIMunicipalBondsForJobSettings": { - "type": "object", - "properties": { - "allowSinkForInstallmentPayment": { - "type": "boolean", - "description": "Allow Sink For Installment Payment" - }, - "ignoreSinkingFund": { - "type": "boolean", - "description": "Ignore Sinking Fund Schedule" - }, - "useAnticipatedSinkSchedule": { - "type": "boolean", - "description": "Anticipate Sink Schedule" - } - }, - "additionalProperties": false - }, - "FIMarketEnvironment": { - "type": "object", - "properties": { - "ratePath": { - "enum": [ - "FLAT", - "FORWARD", - "FLAT & FORWARD" - ], - "type": "string", - "description": "Rate Path", - "default": "FLAT & FORWARD" - } - }, - "additionalProperties": false - }, - "FIServicerAdvances": { - "type": "object", - "properties": { - "advanceType": { - "enum": [ - "Advances All", - "Advances All But Newly Liqdtd", - "Does Not Advance", - "Principal Only", - "Interest Only" - ], - "type": "string", - "description": "Advance Type" - } - }, - "additionalProperties": false - }, - "FIStructuredProductsForJobSettings": { - "type": "object", - "properties": { - "servicerAdvances": { - "$ref": "#/components/schemas/FIServicerAdvances" - }, - "ignoreFinancialGuarantee": { - "type": "string", - "description": "Ignore Financial Guarantee" - }, - "cleanUpCallMethod": { - "type": "boolean", - "description": "Cleanup Call Method" - }, - "doOPTRedeem": { - "type": "string", - "description": "Do OPT Redeem" - }, - "prepayLockout": { - "$ref": "#/components/schemas/FIPrepayLockout" - }, - "cashflows": { - "$ref": "#/components/schemas/FICashflows" - }, - "balloonExtension": { - "$ref": "#/components/schemas/FIBalloonExtension" - } - }, - "additionalProperties": false - }, - "FIJobSettings": { - "required": [ - "asOfDate" - ], - "type": "object", - "properties": { - "asOfDate": { - "type": "string", - "description": "As of date" - }, - "partialDurationMonths": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "Partial duration months" - }, - "callMethod": { - "enum": [ - "No Call", - "Intrinsic Value", - "First Call", - "First Par" - ], - "type": "string", - "description": "Call Method" - }, - "settlement": { - "type": "string", - "description": "Settlement Date" - }, - "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" - }, - "bankLoans": { - "$ref": "#/components/schemas/FIBankLoans" - }, - "municipalBonds": { - "$ref": "#/components/schemas/FIMunicipalBondsForJobSettings" - }, - "marketEnvironment": { - "$ref": "#/components/schemas/FIMarketEnvironment" - }, - "structuredProducts": { - "$ref": "#/components/schemas/FIStructuredProductsForJobSettings" - } - }, - "additionalProperties": false - }, - "FICalculationParameters": { - "required": [ - "calculations", - "jobSettings", - "securities" - ], - "type": "object", - "properties": { - "securities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FISecurity" - }, - "description": "List of securities" - }, - "calculations": { - "type": "array", - "items": { - "type": "string" + "recoveryPercentage": { + "type": "number", + "format": "double" }, - "description": "List of calculations" - }, - "jobSettings": { - "$ref": "#/components/schemas/FIJobSettings" - } - }, - "additionalProperties": false - }, - "CalculationMeta": { - "type": "object", - "properties": { - "contentorganization": { - "enum": [ - "None", - "Row", - "Column", - "SimplifiedRow" - ], - "type": "string", - "default": "SimplifiedRow", - "deprecated": true - }, - "stachContentOrganization": { - "enum": [ - "None", - "Row", - "Column", - "SimplifiedRow" - ], - "type": "string", - "default": "SimplifiedRow" - }, - "contenttype": { - "enum": [ - "Json", - "Binary" - ], - "type": "string", - "default": "Json", - "deprecated": true - }, - "format": { - "enum": [ - "JsonStach", - "Table", - "Tableau", - "BinaryStach", - "Bison", - "Binary", - "Pdf", - "Pptx", - "Feather" - ], - "type": "string", - "default": "JsonStach" - } - }, - "additionalProperties": false - }, - "FICalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FICalculationParameters" - }, - "meta": { - "$ref": "#/components/schemas/CalculationMeta" - } - }, - "additionalProperties": false - }, - "PaDoc": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "PA document path" - } - }, - "additionalProperties": false - }, - "FPOAccount": { - "required": [ - "paDocument" - ], - "type": "object", - "properties": { - "paDocument": { - "$ref": "#/components/schemas/PaDoc" - }, - "id": { - "type": "string", - "description": "Account path" - }, - "overrides": { - "$ref": "#/components/schemas/OptimizerAccountOverrides" - } - }, - "additionalProperties": false - }, - "FPOObjective": { - "type": "object", - "properties": { - "active": { - "type": "string" - }, - "terms": { - "type": "object", - "additionalProperties": { - "enum": [ - "Disable", - "Enable" - ], - "type": "string" - } - } - }, - "additionalProperties": false - }, - "FPOOptimizerStrategyOverrides": { - "type": "object", - "properties": { - "objective": { - "$ref": "#/components/schemas/FPOObjective" - }, - "constraints": { - "type": "object", - "additionalProperties": { - "enum": [ - "Disable", - "Enable" - ], + "redemptionDate": { "type": "string" }, - "description": "List of constraints" - }, - "alpha": { - "type": "string", - "description": "Alpha" - }, - "transactionCost": { - "type": "string", - "description": "Transaction cost" - } - }, - "additionalProperties": false - }, - "FPOOptimizerStrategy": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "overrides": { - "$ref": "#/components/schemas/FPOOptimizerStrategyOverrides" - }, - "id": { - "type": "string", - "description": "OptimizerStrategy document path" - } - }, - "additionalProperties": false - }, - "FPOOptimizationParameters": { - "required": [ - "outputTypes", - "strategy" - ], - "type": "object", - "properties": { - "account": { - "$ref": "#/components/schemas/FPOAccount" - }, - "strategy": { - "$ref": "#/components/schemas/FPOOptimizerStrategy" - }, - "optimization": { - "$ref": "#/components/schemas/Optimization" - }, - "outputTypes": { - "$ref": "#/components/schemas/OptimizerOutputTypes" - } - }, - "additionalProperties": false - }, - "FPOOptimizationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FPOOptimizationParameters" - }, - "meta": { - "$ref": "#/components/schemas/OptimizerCalculationMeta" - } - }, - "additionalProperties": false - }, - "Frequency": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Frequency name." - } - }, - "additionalProperties": false - }, - "FrequencyRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Frequency" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "Group": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Group Name" - }, - "directory": { - "type": "string", - "description": "Group Directory" - }, - "category": { - "type": "string", - "description": "Group Category" - } - }, - "additionalProperties": false - }, - "GroupRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Group" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "TemplateContentTypes": { - "type": "object", - "properties": { - "mandatory": { - "type": "array", - "items": { + "redemptionOpt": { "type": "string" }, - "description": "Template mandatory fields" - }, - "optional": { - "type": "array", - "items": { + "redemptionPrice": { + "type": "number", + "format": "double" + }, + "reinstatedDate": { "type": "string" }, - "description": "Template optional fields" - }, - "locked": { - "type": "array", - "items": { + "resetDelay": { + "type": "integer", + "format": "int32" + }, + "resetFreq": { "type": "string" }, - "description": "Template locked fields" - } - }, - "additionalProperties": false - }, - "LinkedPATemplateParameters": { - "required": [ - "directory", - "parentComponentId" - ], - "type": "object", - "properties": { - "directory": { - "type": "string", - "description": "The directory to create a linked PA template" - }, - "parentComponentId": { - "type": "string", - "description": "Parent component id" - }, - "description": { - "type": "string", - "description": "Template description" - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" - } - }, - "additionalProperties": false - }, - "LinkedPATemplateParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LinkedPATemplateParameters" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "LinkedPATemplatePostSummary": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Template id." - }, - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "parentComponentId": { - "type": "string", - "description": "Template parent tile." - } - }, - "additionalProperties": false - }, - "LinkedPATemplatePostSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LinkedPATemplatePostSummary" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "LinkedPATemplateSummary": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "parentComponentId": { - "type": "string", - "description": "Template parent tile." - } - }, - "additionalProperties": false - }, - "LinkedPATemplateSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/LinkedPATemplateSummary" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "LinkedPATemplateUpdateParameters": { - "type": "object", - "properties": { - "parentComponentId": { - "type": "string", - "description": "Parent component id" - }, - "description": { - "type": "string", - "description": "Template description" - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" - } - }, - "additionalProperties": false - }, - "LinkedPATemplateUpdateParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LinkedPATemplateUpdateParameters" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "LinkedPATemplate": { - "type": "object", - "properties": { - "directory": { - "type": "string", - "description": "Template directory." - }, - "snapshot": { - "type": "boolean", - "description": "snapshot." - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" - }, - "id": { - "type": "string", - "description": "Template id." - }, - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "parentComponentId": { - "type": "string", - "description": "Template parent tile." - } - }, - "additionalProperties": false - }, - "LinkedPATemplateRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LinkedPATemplate" - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "NPOOptimizerStrategyOverrides": { - "type": "object", - "properties": { - "objective": { - "type": "object", - "additionalProperties": { - "type": "object" + "refIndex": { + "type": "string" }, - "description": "Objective parameters" - }, - "constraints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstraintAction" + "secondaryToVendorFlag": { + "type": "boolean" }, - "description": "List of constraints" - }, - "tax": { - "type": "string", - "description": "Tax\r\nCan be set to \"\" for local" - }, - "transactionCost": { - "type": "string", - "description": "Transaction cost\r\nCan be set to \"\" for local" - }, - "alpha": { - "type": "string", - "description": "Alpha" - } - }, - "additionalProperties": false - }, - "NPOOptimizerStrategy": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "overrides": { - "$ref": "#/components/schemas/NPOOptimizerStrategyOverrides" - }, - "id": { - "type": "string", - "description": "OptimizerStrategy document path" - } - }, - "additionalProperties": false - }, - "NPOOptimizationParameters": { - "required": [ - "outputTypes", - "strategy" - ], - "type": "object", - "properties": { - "strategy": { - "$ref": "#/components/schemas/NPOOptimizerStrategy" - }, - "account": { - "$ref": "#/components/schemas/OptimizerAccount" - }, - "optimization": { - "$ref": "#/components/schemas/Optimization" - }, - "outputTypes": { - "$ref": "#/components/schemas/OptimizerOutputTypes" - } - }, - "additionalProperties": false - }, - "NPOOptimizationParametersRoot": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NPOOptimizationParameters" - }, - "meta": { - "$ref": "#/components/schemas/OptimizerCalculationMeta" - } - }, - "additionalProperties": false - }, - "PACalculationGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "FactSet-defined or User-defined Group identifier." - }, - "frequency": { - "type": "string", - "description": "Grouping frequency" - } - }, - "additionalProperties": false - }, - "PACalculationColumn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "FactSet-defined or User-defined Column identifier." - }, - "statistics": { - "type": "array", - "items": { + "sector": { "type": "string" }, - "description": "Column Statistic identifier" - } - }, - "additionalProperties": false - }, - "PACalculationPricingSource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Pricing source identifier" - } - }, - "additionalProperties": false - }, - "PACalculationDataSources": { - "type": "object", - "properties": { - "portfoliopricingsources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationPricingSource" - }, - "description": "List of portfilio pricing source for the PA calculation" - }, - "benchmarkpricingsources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationPricingSource" + "sectorBarclay1": { + "type": "string" }, - "description": "List of benchmark pricing source for the PA calculation" - }, - "useportfoliopricingsourcesforbenchmark": { - "type": "boolean", - "description": "Use portfolio pricing sources for benchmark" - } - }, - "additionalProperties": false - }, - "PACalculationParameters": { - "required": [ - "componentid" - ], - "type": "object", - "properties": { - "componentid": { - "type": "string", - "description": "The PA Engine component identifier to analyze." - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "sectorBarclay2": { + "type": "string" }, - "description": "List of accounts." - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "sectorBarclay3": { + "type": "string" }, - "description": "List of benchmarks." - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationGroup" + "sectorBarclay4": { + "type": "string" }, - "description": "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document." - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationColumn" + "sectorDef": { + "type": "string" }, - "description": "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document." - }, - "datasources": { - "$ref": "#/components/schemas/PACalculationDataSources" - }, - "componentdetail": { - "type": "string", - "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." - } - }, - "additionalProperties": false - }, - "PACalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/PACalculationParameters" - }, - "description": "List of calculation parameters." - }, - "meta": { - "$ref": "#/components/schemas/CalculationMeta" - } - }, - "additionalProperties": false - }, - "CalculationUnitStatus": { - "type": "object", - "properties": { - "status": { - "enum": [ - "Queued", - "Executing", - "Success", - "Failed", - "Cancelled" - ], - "type": "string", - "description": "The status of calculation unit." - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" + "sectorIndustry": { + "type": "string" }, - "description": "The error in a calculation unit." - }, - "result": { - "type": "string", - "description": "The result URL of the calculation." - }, - "progress": { - "type": "string", - "description": "The progress of the calculation unit." - }, - "points": { - "type": "integer", - "description": "The points for the calculation unit.", - "format": "int32" - } - }, - "additionalProperties": false - }, - "CalculationStatus": { - "type": "object", - "properties": { - "calculationid": { - "type": "string", - "description": "Calculation's identifier" - }, - "status": { - "enum": [ - "Queued", - "Executing", - "Completed", - "Cancelled" - ], - "type": "string", - "description": "Calculation's status" - }, - "units": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CalculationUnitStatus" + "sectorMain": { + "type": "string" }, - "description": "Number of calculation units in batch." - } - }, - "additionalProperties": false - }, - "CalculationUnitStatusMeta": { - "type": "object", - "properties": { - "info": { - "type": "string", - "description": "The Info URL of the calculation." - } - }, - "additionalProperties": false - }, - "CalculationStatusMeta": { - "type": "object", - "properties": { - "units": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CalculationUnitStatusMeta" - }, - "description": "Meta of calculation units in batch." - } - }, - "additionalProperties": false - }, - "CalculationStatusRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CalculationStatus" - }, - "meta": { - "$ref": "#/components/schemas/CalculationStatusMeta" - } - }, - "additionalProperties": false - }, - "CalculationsSummary": { - "type": "object", - "properties": { - "status": { - "enum": [ - "Queued", - "Executing", - "Completed", - "Cancelled" - ], - "type": "string", - "description": "Last poll status of the calculation." - }, - "units": { - "type": "integer", - "description": "Number of calculation units in batch.", - "format": "int32" - }, - "requestTime": { - "type": "string", - "description": "Request time of calculation.", - "format": "date-time" - }, - "lastPollTime": { - "type": "string", - "description": "Last poll time of calculation.", - "format": "date-time" - } - }, - "additionalProperties": false - }, - "PaginationInfo": { - "type": "object", - "properties": { - "pageNumber": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "totalPages": { - "type": "integer", - "format": "int32" - }, - "totalCalculations": { - "type": "integer", - "format": "int32" - }, - "nextPage": { - "type": "string" - }, - "previousPage": { - "type": "string" - } - }, - "additionalProperties": false - }, - "PaginationMeta": { - "type": "object", - "properties": { - "pagination": { - "$ref": "#/components/schemas/PaginationInfo" - } - }, - "additionalProperties": false - }, - "CalculationsSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CalculationsSummary" - }, - "meta": { - "$ref": "#/components/schemas/PaginationMeta" - } - }, - "additionalProperties": false - }, - "PAPricingSource": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Pricing source Name" - }, - "directory": { - "type": "string", - "description": "Pricing source directory" - }, - "category": { - "type": "string", - "description": "Pricing source category" - } - }, - "additionalProperties": false - }, - "PAPricingSourceRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/PAPricingSource" - } - }, - "meta": { - "type": "object" - } - }, - "additionalProperties": false - }, - "PubIdentifier": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "User's FactSet account path OR benchmark." - }, - "holdingsmode": { - "type": "string", - "description": "Holdings Mode can be B&H, TBR, OMS or EXT." - } - }, - "additionalProperties": false - }, - "PubDateParameters": { - "required": [ - "enddate" - ], - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." - }, - "enddate": { - "type": "string", - "description": "Calculation's end date or as of date." - } - }, - "additionalProperties": false, - "description": "The date parameters for Publisher calculation." - }, - "PubCalculationParameters": { - "required": [ - "account", - "dates", - "document" - ], - "type": "object", - "properties": { - "document": { - "type": "string", - "description": "The Publisher Engine document to analyze." - }, - "account": { - "$ref": "#/components/schemas/PubIdentifier" - }, - "dates": { - "$ref": "#/components/schemas/PubDateParameters" - } - }, - "additionalProperties": false - }, - "PubCalculationMeta": { - "type": "object", - "additionalProperties": false - }, - "PubCalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/PubCalculationParameters" - }, - "description": "List of calculation parameters." - }, - "meta": { - "$ref": "#/components/schemas/PubCalculationMeta" - } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionUniverse": { - "required": [ - "universeExpr", - "universeType" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantUniverse" - } - ], - "properties": { - "universeExpr": { - "type": "string" - }, - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "securityExpr": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantIdentifierUniverse": { - "required": [ - "identifiers", - "universeType" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantUniverse" - } - ], - "properties": { - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "identifiers": { - "type": "array", - "items": { + "sectorMerrill1": { "type": "string" - } - } - }, - "additionalProperties": false - }, - "QuantUniverse": { - "required": [ - "source" - ], - "type": "object", - "properties": { - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantUniversalScreenUniverse": { - "required": [ - "screen" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantUniverse" - } - ], - "properties": { - "screen": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantDateList": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantDate" - } - ], - "properties": { - "dates": { - "type": "array", - "items": { + }, + "sectorMerrill2": { "type": "string" - } - } - }, - "additionalProperties": false - }, - "QuantDate": { - "required": [ - "calendar", - "frequency", - "source" - ], - "type": "object", - "properties": { - "source": { - "enum": [ - "FdsDate", - "DateList" - ], - "type": "string" - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantFdsDate": { - "required": [ - "endDate", - "startDate" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantDate" - } - ], - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - } - }, - "additionalProperties": false - }, - "QuantFqlExpression": { - "required": [ - "expr", - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantFormula" - } - ], - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - }, - "isArrayReturnType": { - "type": "boolean" + }, + "sectorMerrill3": { + "type": "string" + }, + "sectorMerrill4": { + "type": "string" + }, + "sectorSubGroup": { + "type": "string" + }, + "sinkAmts": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "sinkDates": { + "type": "array", + "items": { + "type": "string" + } + }, + "spread": { + "type": "number", + "format": "double" + }, + "state": { + "type": "string" + }, + "status": { + "type": "string" + }, + "statusDates": { + "type": "array", + "items": { + "type": "string" + } + }, + "statusValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "stepCashRates": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "stepCouponDates": { + "type": "array", + "items": { + "type": "string" + } + }, + "stepCoupons": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "stepPikRates": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "vendorCoverageDate": { + "type": "string" + }, + "vRDNFlag": { + "type": "boolean" + } } }, - "additionalProperties": false - }, - "QuantUniversalScreenParameter": { - "required": [ - "name", - "referenceName" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantFormula" - } - ], - "properties": { - "referenceName": { - "type": "string" - }, - "name": { - "type": "string" + "SMError": { + "type": "object", + "properties": { + "detail": { + "type": "string" + } } }, - "additionalProperties": false - }, - "QuantAllUniversalScreenParameters": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantFormula" - } - ], - "additionalProperties": false - }, - "QuantFormula": { - "required": [ - "source" - ], - "type": "object", - "properties": { - "source": { - "enum": [ - "ScreeningExpression", - "FqlExpression", - "UniversalScreenParameter", - "AllUniversalScreenParameters" - ], - "type": "string" + "OneOfFieldsFields": { + "oneOf": [ + { + "$ref": "#/components/schemas/SMBondFields" + }, + { + "$ref": "#/components/schemas/SMCustomCashFlowFields" + } + ], + "discriminator": { + "propertyName": "securityType", + "mapping": { + "Bond": "#/components/schemas/SMBondFields", + "CCF": "#/components/schemas/SMCustomCashFlowFields" + } } }, - "additionalProperties": false - }, - "QuantScreeningExpression": { - "required": [ - "expr", - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/QuantFormula" - } - ], - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" + "SMRetrieveResponse": { + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "status": { + "enum": [ + "success", + "failure" + ], + "type": "string" + }, + "location": { + "type": "string" + }, + "asofdate": { + "type": "string" + }, + "fields": { + "$ref": "#/components/schemas/OneOfFieldsFields" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMError" + } + } } }, - "additionalProperties": false - }, - "QuantScreeningExpressionUniverseObsolete": { - "required": [ - "universeExpr", - "universeType" - ], - "type": "object", - "properties": { - "universeExpr": { - "type": "string" - }, - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "securityExpr": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" + "SMRetrieveResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMRetrieveResponse" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "QuantUniversalScreenUniverseObsolete": { - "required": [ - "screen" - ], - "type": "object", - "properties": { - "screen": { - "type": "string" - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" + "OneOfSMFields": { + "oneOf": [ + { + "$ref": "#/components/schemas/SMBondFields" + }, + { + "$ref": "#/components/schemas/SMCustomCashFlowFields" + } + ], + "discriminator": { + "propertyName": "securityType", + "mapping": { + "Bond": "#/components/schemas/SMBondFields", + "CCF": "#/components/schemas/SMCustomCashFlowFields" + } } }, - "additionalProperties": false - }, - "QuantIdentifierUniverseObsolete": { - "required": [ - "identifiers", - "universeType" - ], - "type": "object", - "properties": { - "universeType": { - "enum": [ - "Equity", - "Debt" - ], - "type": "string" - }, - "identifiers": { - "type": "array", - "items": { + "SMCreateParameters": { + "required": [ + "fields", + "securityName" + ], + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "location": { + "type": "string" + }, + "asofdate": { "type": "string" + }, + "fields": { + "$ref": "#/components/schemas/OneOfSMFields" } - }, - "source": { - "enum": [ - "ScreeningExpressionUniverse", - "UniversalScreenUniverse", - "IdentifierUniverse" - ], - "type": "string" } }, - "additionalProperties": false - }, - "QuantFdsDateObsolete": { - "required": [ - "calendar", - "endDate", - "frequency", - "startDate" - ], - "type": "object", - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" + "SMCreateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMCreateParameters" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "QuantDateListObsolete": { - "required": [ - "calendar", - "frequency" - ], - "type": "object", - "properties": { - "dates": { - "type": "array", - "items": { + "SMWarning": { + "type": "object", + "properties": { + "detail": { "type": "string" } - }, - "frequency": { - "type": "string" - }, - "calendar": { - "type": "string" - }, - "overrideUniversalScreenCalendar": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "QuantScreeningExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" } }, - "additionalProperties": false - }, - "QuantFqlExpressionObsolete": { - "required": [ - "expr", - "name" - ], - "type": "object", - "properties": { - "expr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dateOffset": { - "type": "string" - }, - "isArrayReturnType": { - "type": "boolean" + "SMCreateResponse": { + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "status": { + "enum": [ + "success", + "failure" + ], + "type": "string" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMWarning" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMError" + } + } } }, - "additionalProperties": false - }, - "QuantUniversalScreenParameterObsolete": { - "required": [ - "name", - "referenceName" - ], - "type": "object", - "properties": { - "referenceName": { - "type": "string" - }, - "name": { - "type": "string" + "SMCreateResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMCreateResponse" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "QuantAllUniversalScreenParametersObsolete": { - "type": "object", - "additionalProperties": false - }, - "OneOfQuantUniverse": { - "oneOf": [ - { - "$ref": "#/components/schemas/QuantUniversalScreenUniverse" - }, - { - "$ref": "#/components/schemas/QuantScreeningExpressionUniverse" - }, - { - "$ref": "#/components/schemas/QuantIdentifierUniverse" - } - ], - "discriminator": { - "propertyName": "source", - "mapping": { - "UniversalScreenUniverse": "#/components/schemas/QuantUniversalScreenUniverse", - "ScreeningExpressionUniverse": "#/components/schemas/QuantScreeningExpressionUniverse", - "IdentifierUniverse": "#/components/schemas/QuantIdentifierUniverse" - } - } - }, - "OneOfQuantDates": { - "oneOf": [ - { - "$ref": "#/components/schemas/QuantFdsDate" - }, - { - "$ref": "#/components/schemas/QuantDateList" - } - ], - "discriminator": { - "propertyName": "source", - "mapping": { - "FdsDate": "#/components/schemas/QuantFdsDate", - "DateList": "#/components/schemas/QuantDateList" - } - } - }, - "OneOfQuantFormulas": { - "oneOf": [ - { - "$ref": "#/components/schemas/QuantScreeningExpression" - }, - { - "$ref": "#/components/schemas/QuantFqlExpression" - }, - { - "$ref": "#/components/schemas/QuantUniversalScreenParameter" - }, - { - "$ref": "#/components/schemas/QuantAllUniversalScreenParameters" - } - ], - "discriminator": { - "propertyName": "source", - "mapping": { - "ScreeningExpression": "#/components/schemas/QuantScreeningExpression", - "FqlExpression": "#/components/schemas/QuantFqlExpression", - "UniversalScreenParameter": "#/components/schemas/QuantUniversalScreenParameter", - "AllUniversalScreenParameters": "#/components/schemas/QuantAllUniversalScreenParameters" - } - } - }, - "OneOfQuantFormulasArray": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OneOfQuantFormulas" - } - }, - "QuantCalculationParameters": { - "type": "object", - "properties": { - "universe": { - "$ref": "#/components/schemas/OneOfQuantUniverse" - }, - "dates": { - "$ref": "#/components/schemas/OneOfQuantDates" - }, - "formulas": { - "$ref": "#/components/schemas/OneOfQuantFormulasArray" - }, - "jobDescription": { - "type": "string" + "SMDeleteParameters": { + "required": [ + "securityName" + ], + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "location": { + "type": "string" + }, + "asofdate": { + "type": "string" + }, + "securityType": { + "enum": [ + "Bond", + "CCF" + ], + "type": "string" + } } }, - "additionalProperties": false - }, - "QuantCalculationMeta": { - "type": "object", - "properties": { - "allowArrayData": { - "type": "boolean" - }, - "contentorganization": { - "enum": [ - "None", - "Row", - "Column", - "SimplifiedRow" - ], - "type": "string", - "default": "SimplifiedRow", - "deprecated": true - }, - "stachContentOrganization": { - "enum": [ - "None", - "Row", - "Column", - "SimplifiedRow" - ], - "type": "string", - "default": "SimplifiedRow" - }, - "contenttype": { - "enum": [ - "Json", - "Binary" - ], - "type": "string", - "default": "Json", - "deprecated": true - }, - "format": { - "enum": [ - "JsonStach", - "Table", - "Tableau", - "BinaryStach", - "Bison", - "Binary", - "Pdf", - "Pptx", - "Feather" - ], - "type": "string", - "default": "JsonStach" + "SMDeleteParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMDeleteParameters" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "QuantCalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/QuantCalculationParameters" - }, - "description": "List of calculation parameters." - }, - "meta": { - "$ref": "#/components/schemas/QuantCalculationMeta" + "SMDeleteResponse": { + "type": "object", + "properties": { + "securityName": { + "type": "string" + }, + "status": { + "enum": [ + "success", + "failure" + ], + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMError" + } + } } }, - "additionalProperties": false - }, - "SPARDateParameters": { - "required": [ - "enddate", - "frequency", - "startdate" - ], - "type": "object", - "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." - }, - "enddate": { - "type": "string", - "description": "Calculation's end date." - }, - "frequency": { - "type": "string", - "description": "Calculation's frequency." + "SMDeleteResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SMDeleteResponse" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false, - "description": "The date parameters for SPAR calculation." - }, - "SPARCalculationParameters": { - "required": [ - "componentid" - ], - "type": "object", - "properties": { - "componentid": { - "type": "string", - "description": "The SPAR Engine component identifier to analyze." - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SPARIdentifier" + "SMTemplateFieldProperties": { + "type": "object", + "properties": { + "category": { + "type": "array", + "items": { + "type": "string" + } }, - "description": "List of accounts for SPAR calculation." - }, - "benchmark": { - "$ref": "#/components/schemas/SPARIdentifier" - }, - "dates": { - "$ref": "#/components/schemas/SPARDateParameters" - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." + "mandatory": { + "type": "boolean" + }, + "whenField": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } }, - "additionalProperties": false - }, - "SPARCalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/SPARCalculationParameters" - }, - "description": "List of calculation parameters." - }, - "meta": { - "$ref": "#/components/schemas/CalculationMeta" + "SMTemplateFieldPropertiesRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/SMTemplateFieldProperties" + } + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "PAComponentData": { - "type": "object", - "properties": { - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" - }, - "description": "List of accounts." - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "PAComponentData": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of accounts." }, - "description": "List of benchmarks." - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationGroup" + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of benchmarks." }, - "description": "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document." - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationColumn" + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationGroup" + }, + "description": "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document." }, - "description": "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document." - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "datasources": { - "$ref": "#/components/schemas/PACalculationDataSources" - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." - }, - "componentdetail": { - "type": "string", - "description": "PA Storage type. It can be GROUPS or TOTALS or SECURITIES." + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationColumn" + }, + "description": "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document." + }, + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "datasources": { + "$ref": "#/components/schemas/PACalculationDataSources" + }, + "currencyisocode": { + "type": "string", + "description": "Currency ISO code for calculation." + }, + "componentdetail": { + "type": "string", + "description": "PA Storage type. It can be GROUPS or TOTALS or SECURITIES." + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentParameters": { - "required": [ - "directory", - "parentTemplateId" - ], - "type": "object", - "properties": { - "directory": { - "type": "string", - "description": "Directory to create templated components" - }, - "parentTemplateId": { - "type": "string", - "description": "Parent template id" - }, - "description": { - "type": "string", - "description": "Component description." - }, - "componentData": { - "$ref": "#/components/schemas/PAComponentData" + "TemplatedPAComponentParameters": { + "required": [ + "directory", + "parentTemplateId" + ], + "type": "object", + "properties": { + "directory": { + "type": "string", + "description": "Directory to create templated components" + }, + "parentTemplateId": { + "type": "string", + "description": "Parent template id" + }, + "description": { + "type": "string", + "description": "Component description." + }, + "componentData": { + "$ref": "#/components/schemas/PAComponentData" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TemplatedPAComponentParameters" - }, - "meta": { - "type": "object" + "TemplatedPAComponentParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TemplatedPAComponentParameters" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentPostSummary": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parentTemplateId": { - "type": "string" - }, - "type": { - "type": "string" + "TemplatedPAComponentPostSummary": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parentTemplateId": { + "type": "string" + }, + "type": { + "type": "string" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentPostSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TemplatedPAComponentPostSummary" - }, - "meta": { - "type": "object" + "TemplatedPAComponentPostSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummary" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentSummary": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parentTemplateId": { - "type": "string" - }, - "type": { - "type": "string" + "TemplatedPAComponentSummary": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parentTemplateId": { + "type": "string" + }, + "type": { + "type": "string" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/TemplatedPAComponentSummary" + "TemplatedPAComponentSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/TemplatedPAComponentSummary" + } + }, + "meta": { + "type": "object" } - }, - "meta": { - "type": "object" } }, - "additionalProperties": false - }, - "TemplatedPAComponentUpdateParameters": { - "type": "object", - "properties": { - "parentTemplateId": { - "type": "string", - "description": "Parent template id" - }, - "description": { - "type": "string", - "description": "Component description." - }, - "componentData": { - "$ref": "#/components/schemas/PAComponentData" + "TemplatedPAComponentUpdateParameters": { + "type": "object", + "properties": { + "parentTemplateId": { + "type": "string", + "description": "Parent template id" + }, + "description": { + "type": "string", + "description": "Component description." + }, + "componentData": { + "$ref": "#/components/schemas/PAComponentData" + } } - }, - "additionalProperties": false - }, - "TemplatedPAComponentUpdateParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TemplatedPAComponentUpdateParameters" - }, - "meta": { - "type": "object" + }, + "TemplatedPAComponentUpdateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TemplatedPAComponentUpdateParameters" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponent": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "directory": { - "type": "string" - }, - "snapshot": { - "type": "boolean" - }, - "componentData": { - "$ref": "#/components/schemas/PAComponentData" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parentTemplateId": { - "type": "string" - }, - "type": { - "type": "string" + "TemplatedPAComponent": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "directory": { + "type": "string" + }, + "snapshot": { + "type": "boolean" + }, + "componentData": { + "$ref": "#/components/schemas/PAComponentData" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parentTemplateId": { + "type": "string" + }, + "type": { + "type": "string" + } } }, - "additionalProperties": false - }, - "TemplatedPAComponentRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TemplatedPAComponent" - }, - "meta": { - "type": "object" + "TemplatedPAComponentRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TemplatedPAComponent" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateParameters": { - "required": [ - "directory", - "templateTypeId" - ], - "type": "object", - "properties": { - "directory": { - "type": "string", - "description": "The directory to create an unlinked PA template" - }, - "templateTypeId": { - "type": "string", - "description": "Template type id" - }, - "description": { - "type": "string", - "description": "Template description" - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "UnlinkedPATemplateParameters": { + "required": [ + "directory", + "templateTypeId" + ], + "type": "object", + "properties": { + "directory": { + "type": "string", + "description": "The directory to create an unlinked PA template" }, - "description": "List of accounts" - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "templateTypeId": { + "type": "string", + "description": "Template type id" }, - "description": "List of benchmarks" - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationColumn" + "description": { + "type": "string", + "description": "Template description" }, - "description": "List of columns for the PA calculation" - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationGroup" + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of accounts" }, - "description": "List of groupings for the PA calculation" - }, - "datasources": { - "$ref": "#/components/schemas/PACalculationDataSources" - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." - }, - "componentdetail": { - "type": "string", - "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of benchmarks" + }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationColumn" + }, + "description": "List of columns for the PA calculation" + }, + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationGroup" + }, + "description": "List of groupings for the PA calculation" + }, + "datasources": { + "$ref": "#/components/schemas/PACalculationDataSources" + }, + "currencyisocode": { + "type": "string", + "description": "Currency ISO code for calculation." + }, + "componentdetail": { + "type": "string", + "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." + }, + "content": { + "$ref": "#/components/schemas/TemplateContentTypes" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UnlinkedPATemplateParameters" - }, - "meta": { - "type": "object" + "UnlinkedPATemplateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplateParameters" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplatePostSummary": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Template id." - }, - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "category": { - "type": "string", - "description": "Unlinked template category" + "UnlinkedPATemplatePostSummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Template id." + }, + "description": { + "type": "string", + "description": "Template description." + }, + "name": { + "type": "string", + "description": "Template name." + }, + "category": { + "type": "string", + "description": "Unlinked template category" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplatePostSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UnlinkedPATemplatePostSummary" - }, - "meta": { - "type": "object" + "UnlinkedPATemplatePostSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummary" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateSummary": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "category": { - "type": "string", - "description": "Unlinked template category" + "UnlinkedPATemplateSummary": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Template description." + }, + "name": { + "type": "string", + "description": "Template name." + }, + "category": { + "type": "string", + "description": "Unlinked template category" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateSummaryRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummary" + "UnlinkedPATemplateSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UnlinkedPATemplateSummary" + } + }, + "meta": { + "type": "object" } - }, - "meta": { - "type": "object" } }, - "additionalProperties": false - }, - "UnlinkedPATemplateUpdateParameters": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Template description" - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "UnlinkedPATemplateUpdateParameters": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Template description" }, - "description": "List of accounts" - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of accounts" }, - "description": "List of benchmarks" - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationColumn" + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of benchmarks" }, - "description": "List of columns for the PA calculation" - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationGroup" + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationColumn" + }, + "description": "List of columns for the PA calculation" }, - "description": "List of groupings for the PA calculation" - }, - "datasources": { - "$ref": "#/components/schemas/PACalculationDataSources" - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." - }, - "componentdetail": { - "type": "string", - "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationGroup" + }, + "description": "List of groupings for the PA calculation" + }, + "datasources": { + "$ref": "#/components/schemas/PACalculationDataSources" + }, + "currencyisocode": { + "type": "string", + "description": "Currency ISO code for calculation." + }, + "componentdetail": { + "type": "string", + "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." + }, + "content": { + "$ref": "#/components/schemas/TemplateContentTypes" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateUpdateParametersRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParameters" - }, - "meta": { - "type": "object" + "UnlinkedPATemplateUpdateParametersRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParameters" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Template id." - }, - "directory": { - "type": "string", - "description": "Template directory." - }, - "templateTypeId": { - "type": "string", - "description": "Template type id" - }, - "snapshot": { - "type": "boolean", - "description": "snapshot." - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "UnlinkedPATemplate": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Template id." }, - "description": "List of accounts" - }, - "benchmarks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PAIdentifier" + "directory": { + "type": "string", + "description": "Template directory." }, - "description": "List of benchmarks" - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationColumn" + "templateTypeId": { + "type": "string", + "description": "Template type id" }, - "description": "List of columns for the PA calculation" - }, - "dates": { - "$ref": "#/components/schemas/PADateParameters" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PACalculationGroup" + "snapshot": { + "type": "boolean", + "description": "snapshot." }, - "description": "List of groupings for the PA calculation" - }, - "datasources": { - "$ref": "#/components/schemas/PACalculationDataSources" - }, - "currencyisocode": { - "type": "string", - "description": "Currency ISO code for calculation." - }, - "componentdetail": { - "type": "string", - "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." - }, - "content": { - "$ref": "#/components/schemas/TemplateContentTypes" - }, - "description": { - "type": "string", - "description": "Template description." - }, - "name": { - "type": "string", - "description": "Template name." - }, - "category": { - "type": "string", - "description": "Unlinked template category" + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of accounts" + }, + "benchmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PAIdentifier" + }, + "description": "List of benchmarks" + }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationColumn" + }, + "description": "List of columns for the PA calculation" + }, + "dates": { + "$ref": "#/components/schemas/PADateParameters" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PACalculationGroup" + }, + "description": "List of groupings for the PA calculation" + }, + "datasources": { + "$ref": "#/components/schemas/PACalculationDataSources" + }, + "currencyisocode": { + "type": "string", + "description": "Currency ISO code for calculation." + }, + "componentdetail": { + "type": "string", + "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." + }, + "content": { + "$ref": "#/components/schemas/TemplateContentTypes" + }, + "description": { + "type": "string", + "description": "Template description." + }, + "name": { + "type": "string", + "description": "Template name." + }, + "category": { + "type": "string", + "description": "Unlinked template category" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UnlinkedPATemplate" - }, - "meta": { - "type": "object" + "UnlinkedPATemplateRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplate" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateCategoryAndType": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Unlinked template category" - }, - "name": { - "type": "string", - "description": "Unlinked template type" + "UnlinkedPATemplateCategoryAndType": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Unlinked template category" + }, + "name": { + "type": "string", + "description": "Unlinked template type" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateCategoryAndTypeRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndType" + "UnlinkedPATemplateCategoryAndTypeRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndType" + } + }, + "meta": { + "type": "object" } - }, - "meta": { - "type": "object" } }, - "additionalProperties": false - }, - "UnlinkedPATemplateColumnDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unlinked template column name" - }, - "id": { - "type": "string", - "description": "FactSet-defined or User-defined Column identifier." - }, - "statistics": { - "type": "array", - "items": { - "type": "string" + "UnlinkedPATemplateColumnDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Unlinked template column name" }, - "description": "Column Statistic identifier" + "id": { + "type": "string", + "description": "FactSet-defined or User-defined Column identifier." + }, + "statistics": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Column Statistic identifier" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateGroupDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unlinked template group name" - }, - "id": { - "type": "string", - "description": "FactSet-defined or User-defined Group identifier." - }, - "frequency": { - "type": "string", - "description": "Grouping frequency" + "UnlinkedPATemplateGroupDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Unlinked template group name" + }, + "id": { + "type": "string", + "description": "FactSet-defined or User-defined Group identifier." + }, + "frequency": { + "type": "string", + "description": "Grouping frequency" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateCategoryAndTypeDetails": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Type Id" - }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UnlinkedPATemplateColumnDetails" + "UnlinkedPATemplateCategoryAndTypeDetails": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Type Id" }, - "description": "List of default columns" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UnlinkedPATemplateGroupDetails" + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnlinkedPATemplateColumnDetails" + }, + "description": "List of default columns" }, - "description": "List of default groupings" - }, - "snapshot": { - "type": "boolean", - "description": "Snapshot" - }, - "category": { - "type": "string", - "description": "Unlinked template category" - }, - "name": { - "type": "string", - "description": "Unlinked template type" + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnlinkedPATemplateGroupDetails" + }, + "description": "List of default groupings" + }, + "snapshot": { + "type": "boolean", + "description": "Snapshot" + }, + "category": { + "type": "string", + "description": "Unlinked template category" + }, + "name": { + "type": "string", + "description": "Unlinked template type" + } } }, - "additionalProperties": false - }, - "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails" - }, - "meta": { - "type": "object" + "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails" + }, + "meta": { + "type": "object" + } } }, - "additionalProperties": false - }, - "VaultCalculationParameters": { - "required": [ - "account", - "componentid", - "configid" - ], - "type": "object", - "properties": { - "componentid": { - "type": "string", - "description": "The Vault component identifier to analyze." - }, - "account": { - "$ref": "#/components/schemas/VaultIdentifier" - }, - "dates": { - "$ref": "#/components/schemas/VaultDateParameters" - }, - "configid": { - "type": "string", - "description": "Vault Configuration identifier." - }, - "componentdetail": { - "type": "string", - "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." + "VaultAttributionLoaderResponse": { + "type": "object", + "properties": { + "processId": { + "type": "string", + "description": "ProcessId." + }, + "groupId": { + "type": "string", + "description": "GroupId." + }, + "objectId": { + "type": "string", + "description": "ObjectId." + } } }, - "additionalProperties": false - }, - "VaultCalculationParametersRoot": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/VaultCalculationParameters" - }, - "description": "List of calculation parameters." - }, - "meta": { - "$ref": "#/components/schemas/CalculationMeta" + "VaultAttributionLoaderResponseRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/VaultAttributionLoaderResponse" + }, + "meta": { + "type": "object" + } + } + }, + "VaultCalculationParameters": { + "required": [ + "account", + "componentid", + "configid" + ], + "type": "object", + "properties": { + "componentid": { + "type": "string", + "description": "The Vault component identifier to analyze." + }, + "account": { + "$ref": "#/components/schemas/VaultIdentifier" + }, + "dates": { + "$ref": "#/components/schemas/VaultDateParameters" + }, + "configid": { + "type": "string", + "description": "Vault Configuration identifier." + }, + "componentdetail": { + "type": "string", + "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." + } } }, - "additionalProperties": false + "VaultCalculationParametersRoot": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/VaultCalculationParameters" + }, + "description": "List of calculation parameters." + }, + "meta": { + "$ref": "#/components/schemas/CalculationMeta" + } + } + } + }, + "securitySchemes": { + "Basic": { + "type": "http", + "description": "Input your username and password to access this API", + "scheme": "basic" + }, + "Bearer": { + "type": "http", + "description": "JWT Authorization header using the Bearer scheme.", + "scheme": "bearer" + } } }, - "securitySchemes": { - "Basic": { - "type": "http", - "description": "Input your username and password to access this API", - "scheme": "basic" - }, - "Bearer": { - "type": "http", - "description": "JWT Authorization header using the Bearer scheme.", - "scheme": "bearer" + "security": [ + { + "Basic": [ ], + "Bearer": [ ] } + ], + "externalDocs": { + "description": "API Documentation", + "url": "https://developer.factset.com/api-catalog/" } - }, - "security": [ - { - "Basic": [ ], - "Bearer": [ ] - } - ], - "externalDocs": { - "description": "API Documentation", - "url": "https://developer.factset.com/api-catalog/" - } -} \ No newline at end of file + } \ No newline at end of file