diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index 34fbd28..ee31c99 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -4,7 +4,7 @@ env: USER_API_KEY: ${{ secrets.USER_API_KEY }} USER_EMAIL: ${{ secrets.USER_EMAIL }} USER: ${{ secrets.USER }} - OPENAPI_GENERATOR_VERSION: 5.1.0 + OPENAPI_GENERATOR_VERSION: 5.3.1 GITHUB_DOTNET_SDK_REPO: factset/analyticsapi-engines-dotnet-sdk GITHUB_PYTHON_SDK_REPO: factset/analyticsapi-engines-python-sdk GITHUB_JAVA_SDK_REPO: factset/analyticsapi-engines-java-sdk diff --git a/languages/dotnet/openapi-generator-config.json b/languages/dotnet/openapi-generator-config.json index 6f1bf87..4c476d5 100644 --- a/languages/dotnet/openapi-generator-config.json +++ b/languages/dotnet/openapi-generator-config.json @@ -4,6 +4,7 @@ "packageGuid": "{D7309227-518B-45ED-896A-4853BE6A9075}", "targetFramework": "netstandard2.0", "caseInsensitiveResponseHeaders": true, + "useOneOfDiscriminatorLookup": true, "packageAuthors": "FactSet", "packageTitle": "FactSet Analytics Engines API", "packageDescription": "Allow clients to fetch Engines Analytics through APIs.", @@ -16,5 +17,6 @@ "licenseId": "Apache-2.0", "releaseNote": "Refer to Changelog on GitHub source repository", "packageTags": "PA;Vault;SPAR;Engines;FactSet;FDS;API;Analytics;AnalyticsAPI", - "httpUserAgent": "engines-api/5.2.0/csharp" + "httpUserAgent": "engines-api/5.2.0/csharp", + "disallowAdditionalPropertiesIfNotPresent": false } diff --git a/languages/java/openapi-generator-config.json b/languages/java/openapi-generator-config.json index 77966cf..900617f 100644 --- a/languages/java/openapi-generator-config.json +++ b/languages/java/openapi-generator-config.json @@ -22,6 +22,8 @@ "useGzipFeature": false, "hideGenerationTimestamp": true, "caseInsensitiveResponseHeaders": true, + "useOneOfDiscriminatorLookup": true, + "disallowAdditionalPropertiesIfNotPresent": false, "library": "jersey2", "servers": false, "httpUserAgent": "engines-api/5.2.0/java" diff --git a/languages/python/openapi-generator-config.json b/languages/python/openapi-generator-config.json index 6416ee0..05c9732 100644 --- a/languages/python/openapi-generator-config.json +++ b/languages/python/openapi-generator-config.json @@ -1,7 +1,7 @@ { "packageName": "fds.analyticsapi.engines", "projectName": "fds.analyticsapi.engines", - "packageVersion": "5.2.0", + "packageVersion": "5.3.0", "packageUrl": "https://github.com/factset/analyticsapi-engines-python-sdk", - "httpUserAgent": "engines-api/5.2.0/python" + "httpUserAgent": "engines-api/5.3.0/python" } diff --git a/openapi-generator/Dockerfile b/openapi-generator/Dockerfile index 4575c02..86b392d 100644 --- a/openapi-generator/Dockerfile +++ b/openapi-generator/Dockerfile @@ -1,6 +1,6 @@ FROM openjdk:8 -ARG VERSION=5.1.0 +ARG VERSION=5.3.1 ENV GEN_DIR /opt/openapi-generator diff --git a/openapi-schema.json b/openapi-schema.json index d9ab41f..7c193df 100644 --- a/openapi-schema.json +++ b/openapi-schema.json @@ -7799,26 +7799,18 @@ "Components" ], "summary": "Get PA components", - "description": "This endpoint returns \r\n\r\n1.List of PA components in a given PA document if document name is provided.\r\n\r\n2.List of components in given directory if directory is provided.", + "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" } - }, - { - "name": "directory", - "in": "query", - "description": "Directory to get the components", - "schema": { - "type": "string", - "description": "Directory to get the components" - } } ], "responses": { @@ -18333,7 +18325,7 @@ "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, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* Mandatory and locked strings are mutually exclusive.", + "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\", \"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", @@ -18386,7 +18378,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" } } } @@ -18633,7 +18625,7 @@ "x-success-response-types": [ { "status-code": "201", - "response-type": "LinkedPATemplateSummaryRoot" + "response-type": "LinkedPATemplatePostSummaryRoot" } ] }, @@ -18978,7 +18970,7 @@ "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, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* Mandatory and locked strings are mutually exclusive.", + "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\", \"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": [ { @@ -19043,7 +19035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/LinkedPATemplatePostSummaryRoot" } } } @@ -19297,7 +19289,7 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "LinkedPATemplateSummaryRoot" + "response-type": "LinkedPATemplatePostSummaryRoot" } ] }, @@ -32878,7 +32870,7 @@ "TemplatedPAComponents" ], "summary": "Create templated PA component", - "description": "This endpoint creates new component based off of linked PA template or unlinked PA template.", + "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.", "operationId": "createTemplatedPAComponents", "requestBody": { "description": "Request Parameters", @@ -32931,17 +32923,17 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" } } } @@ -33198,45 +33190,32 @@ "x-success-response-types": [ { "status-code": "201", - "response-type": "TemplatedPAComponentSummaryRoot" + "response-type": "TemplatedPAComponentPostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/templated-components/{id}": { - "put": { + }, + "get": { "tags": [ "TemplatedPAComponents" ], - "summary": "Update templated PA component", - "description": "This endpoint allows the user to change the request body from an existing templated PA component.", - "operationId": "updateTemplatedPAComponents", + "summary": "Get templated PA components in path", + "description": "This endpoint returns the list of templated PA components in path.", + "operationId": "getTemplatedPAComponentsInPath", "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for a templated PA component", + "name": "directory", + "in": "query", + "description": "Get templated PA components in path", "required": true, "schema": { "type": "string", - "description": "Unique identifier for a templated PA component" + "description": "Get templated PA components in path" } } ], - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" - } - } - }, - "required": true - }, "responses": { "200": { - "description": "Expected response, updated successfully.", + "description": "Expected response, returns a list templated PA components.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33323,50 +33302,6 @@ } } }, - "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": { @@ -33531,14 +33466,16 @@ "response-type": "TemplatedPAComponentSummaryRoot" } ] - }, - "delete": { + } + }, + "/analytics/engines/pa/v3/templated-components/{id}": { + "put": { "tags": [ "TemplatedPAComponents" ], - "summary": "Delete templated PA component", - "description": "This endpoint deletes an existing templated PA component", - "operationId": "deleteTemplatedPAComponents", + "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.", + "operationId": "updateTemplatedPAComponents", "parameters": [ { "name": "id", @@ -33551,9 +33488,20 @@ } } ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentUpdateParametersRoot" + } + } + }, + "required": true + }, "responses": { - "204": { - "description": "Expected response, deleted the templated PA component successfully.", + "200": { + "description": "Expected response, updated successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33587,6 +33535,13 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TemplatedPAComponentPostSummaryRoot" + } + } } }, "400": { @@ -33626,25 +33581,15 @@ } }, "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.", + "description": "Component or template not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33680,20 +33625,10 @@ } }, "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } } } }, @@ -33857,34 +33792,33 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "TemplatedPAComponentPostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates": { - "post": { + }, + "get": { "tags": [ - "UnlinkedPATemplates" + "TemplatedPAComponents" ], - "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, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* Mandatory and locked strings are mutually exclusive.", - "operationId": "createUnlinkedPATemplates", - "requestBody": { - "description": "Request Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" - } + "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" } - }, - "required": true - }, + } + ], "responses": { - "201": { - "description": "Expected response, created a unlinked PA template.", + "200": { + "description": "Expected response, templated PA component details.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -33922,7 +33856,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/TemplatedPAComponentRoot" } } } @@ -33971,6 +33905,50 @@ } } }, + "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": { @@ -34131,41 +34109,33 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "201", - "response-type": "UnlinkedPATemplateSummaryRoot" + "status-code": "200", + "response-type": "TemplatedPAComponentRoot" } ] }, - "get": { + "delete": { "tags": [ - "UnlinkedPATemplates" + "TemplatedPAComponents" ], - "summary": "Get unlinked PA templates", - "description": "This endpoint returns the list of unlinked PA templates.", - "operationId": "getUnlinkedPATemplates", + "summary": "Delete templated PA component", + "description": "This endpoint deletes an existing templated PA component", + "operationId": "deleteTemplatedPAComponents", "parameters": [ { - "name": "directory", - "in": "query", - "description": "Get unlinked PA templates in path.", - "schema": { - "type": "string", - "description": "Get unlinked PA templates in path." - } - }, - { - "name": "category", - "in": "query", - "description": "Get unlinked PA templates by category.", + "name": "id", + "in": "path", + "description": "Unique identifier for a templated PA component", + "required": true, "schema": { "type": "string", - "description": "Get unlinked PA templates by category." + "description": "Unique identifier for a templated PA component" } } ], "responses": { - "200": { - "description": "Expected response, returns a list of unlinked PA templates.", + "204": { + "description": "Expected response, deleted the templated PA component successfully.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34199,13 +34169,6 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" - } - } } }, "400": { @@ -34245,10 +34208,74 @@ } }, "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" + } } } }, @@ -34412,46 +34439,34 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "UnlinkedPATemplateSummaryRoot" + "status-code": "204", + "response-type": null } ] } }, - "/analytics/engines/pa/v3/unlinked-templates/{id}": { - "put": { + "/analytics/engines/pa/v3/unlinked-templates": { + "post": { "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, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* Mandatory and locked strings are mutually exclusive.", - "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" - } - } - ], + "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\", \"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.", + "operationId": "createUnlinkedPATemplates", "requestBody": { "description": "Request Parameters", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateParametersRoot" } } }, "required": true }, "responses": { - "200": { - "description": "Expected response, updated the unlinked PA template.", + "201": { + "description": "Expected response, created a unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34489,7 +34504,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } @@ -34538,50 +34553,6 @@ } } }, - "404": { - "description": "Template not found.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", - "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." - } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } - } - }, "401": { "description": "Missing or invalid authentication.", "headers": { @@ -34742,70 +34713,41 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "UnlinkedPATemplateSummaryRoot" + "status-code": "201", + "response-type": "UnlinkedPATemplatePostSummaryRoot" } ] }, - "delete": { + "get": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Delete unlinked PA template", - "description": "This endpoint deletes an existing unliked PA template.", - "operationId": "deleteUnlinkedPATemplates", + "summary": "Get unlinked PA templates", + "description": "This endpoint returns the list of unlinked PA templates.", + "operationId": "getUnlinkedPATemplates", "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for an unlinked PA template", - "required": true, + "name": "directory", + "in": "query", + "description": "Get unlinked PA templates in path.", "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template" + "description": "Get unlinked PA templates in path." + } + }, + { + "name": "category", + "in": "query", + "description": "Get unlinked PA templates by category.", + "schema": { + "type": "string", + "description": "Get unlinked PA templates by category." } } ], "responses": { - "204": { - "description": "Expected response, deleted the 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.", + "200": { + "description": "Expected response, returns a list of unlinked PA templates.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -34843,13 +34785,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/UnlinkedPATemplateSummaryRoot" } } } }, - "404": { - "description": "Template not found.", + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35052,18 +34994,20 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "200", + "response-type": "UnlinkedPATemplateSummaryRoot" } ] - }, - "get": { + } + }, + "/analytics/engines/pa/v3/unlinked-templates/{id}": { + "put": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Get unlinked PA template details by id", - "description": "This endpoint fetches the template settings.", - "operationId": "getUnlinkedPATemplatesById", + "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\", \"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.", + "operationId": "updateUnlinkedPATemplates", "parameters": [ { "name": "id", @@ -35076,9 +35020,20 @@ } } ], + "requestBody": { + "description": "Request Parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParametersRoot" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "Expected response, get details of the unlinked PA template.", + "description": "Expected response, updated the unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35116,7 +35071,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateRoot" + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummaryRoot" } } } @@ -35370,22 +35325,69 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateRoot" + "response-type": "UnlinkedPATemplatePostSummaryRoot" } ] - } - }, - "/analytics/engines/pa/v3/unlinked-templates/template-types": { - "get": { + }, + "delete": { "tags": [ "UnlinkedPATemplates" ], - "summary": "Get default unlinked PA template types.", - "description": "This endpoint fetches default unlinked PA template types.", - "operationId": "getDefaultUnlinkedPATemplateTypes", + "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": { - "200": { - "description": "Expected response, default unlinked PA template types", + "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.", @@ -35423,7 +35425,51 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" + "$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" } } } @@ -35588,35 +35634,33 @@ "x-are-multiple-success-responses-different": false, "x-success-response-types": [ { - "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeRoot" + "status-code": "204", + "response-type": null } ] - } - }, - "/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", + "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 type", + "description": "Unique identifier for an unlinked PA template", "required": true, "schema": { "type": "string", - "description": "Unique identifier for an unlinked PA template type" + "description": "Unique identifier for an unlinked PA template" } } ], "responses": { "200": { - "description": "Expected response, details of the unlinked PA template type", + "description": "Expected response, get details of the unlinked PA template.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35654,7 +35698,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateRoot" } } } @@ -35704,7 +35748,7 @@ } }, "404": { - "description": "Unlinked PA template type not found.", + "description": "Template not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -35908,106 +35952,22 @@ "x-success-response-types": [ { "status-code": "200", - "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" + "response-type": "UnlinkedPATemplateRoot" } ] } }, - "/analytics/engines/vault/v3/calculations": { - "post": { + "/analytics/engines/pa/v3/unlinked-templates/template-types": { + "get": { "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" - } - } + "UnlinkedPATemplates" ], - "requestBody": { - "description": "Calculation Parameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VaultCalculationParametersRoot" - } - } - } - }, + "summary": "Get default unlinked PA template types.", + "description": "This endpoint fetches default unlinked PA template types.", + "operationId": "getDefaultUnlinkedPATemplateTypes", "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.", + "description": "Expected response, default unlinked PA template types", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36045,18 +36005,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/CalculationStatusRoot" + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot" } } } }, - "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.", + "401": { + "description": "Missing or invalid authentication.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36071,41 +36026,11 @@ "type": "string", "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } - }, - "X-FactSet-Api-RateLimit-Limit": { - "description": "Number of allowed requests for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Remaining": { - "description": "Number of requests left for the time window.", - "schema": { - "type": "string" - } - }, - "X-FactSet-Api-RateLimit-Reset": { - "description": "Number of seconds remaining till rate limit resets.", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ObjectRoot" - } } } }, - "400": { - "description": "Invalid calculation parameters.", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36139,22 +36064,10 @@ "type": "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/x-protobuf": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "404": { - "description": "One or more calculation settings were unavailable.", + "406": { + "description": "Unsupported Accept header. Header needs to be set to application/json.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36188,22 +36101,35 @@ "type": "string" } } - }, - "content": { - "application/json": { + } + }, + "429": { + "description": "Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "FactSet's request key header." } }, - "application/x-protobuf": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "type": "string", + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + } + }, + "Retry-After": { + "description": "Time to wait in seconds before making a new request as the rate limit has reached.", + "schema": { + "type": "string" } } } }, - "401": { - "description": "Missing or invalid authentication.", + "500": { + "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36221,8 +36147,58 @@ } } }, - "403": { - "description": "User is forbidden with current credentials", + "503": { + "description": "Request timed out. Retry the request in sometime.", + "headers": { + "X-DataDirect-Request-Key": { + "description": "FactSet's request key header.", + "schema": { + "type": "string", + "description": "FactSet's request key header." + } + }, + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API 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.", @@ -36256,10 +36232,17 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot" + } + } } }, - "415": { - "description": "Missing/Invalid Content-Type header. Header needs to be set to application/json.", + "400": { + "description": "Invalid data provided. Please check the request parameters before attempting again.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36293,10 +36276,17 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, - "429": { - "description": "Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire.", + "404": { + "description": "Unlinked PA template type not found.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36329,6 +36319,125 @@ "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.", @@ -36377,46 +36486,28 @@ } } }, - "x-are-multiple-success-responses-different": true, + "x-are-multiple-success-responses-different": false, "x-success-response-types": [ - { - "status-code": "202", - "response-type": "CalculationStatusRoot" - }, { "status-code": "200", - "response-type": "CalculationStatusRoot" - }, - { - "status-code": "201", - "response-type": "ObjectRoot" + "response-type": "UnlinkedPATemplateCategoryAndTypeDetailsRoot" } ] } }, - "/analytics/engines/vault/v3/calculations/{id}": { - "put": { + "/analytics/engines/vault/v3/calculations": { + "post": { "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", + "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": "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.", + "description": "Long running deadline in seconds when only one unit is passed in the POST body.", "schema": { "type": "integer" } @@ -36596,7 +36687,7 @@ } }, "400": { - "description": "Invalid Calculation Parameters.", + "description": "Invalid calculation parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -36693,55 +36784,6 @@ } } }, - "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": { @@ -36932,14 +36974,16 @@ "response-type": "ObjectRoot" } ] - }, - "get": { + } + }, + "/analytics/engines/vault/v3/calculations/{id}": { + "put": { "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", + "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", @@ -36950,31 +36994,43 @@ "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": { - "200": { - "description": "Expected response, returns the Vault calculation parameters.", + "202": { + "description": "Expected response, contains the poll URL in the Location header.", "headers": { - "Content-Encoding": { - "description": "Standard HTTP header. Header value based on Accept-Encoding Request header.", - "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.", + "Location": { + "description": "URL to poll for the resulting calculation", "schema": { "type": "string", - "description": "Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified." + "description": "URL to poll for the resulting calculation" } }, "X-DataDirect-Request-Key": { @@ -37013,13 +37069,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VaultCalculationParametersRoot" + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" } } } }, - "400": { - "description": "Invalid identifier provided.", + "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.", @@ -37057,13 +37118,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "$ref": "#/components/schemas/CalculationStatusRoot" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/CalculationStatusRoot" } } } }, - "404": { - "description": "Calculation id not found", + "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.", @@ -37101,32 +37167,18 @@ "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." + "$ref": "#/components/schemas/ObjectRoot" } }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "application/x-protobuf": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/ObjectRoot" } } } }, - "403": { - "description": "User is forbidden with current credentials", + "400": { + "description": "Invalid Calculation Parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37160,77 +37212,22 @@ "type": "string" } } - } - }, - "500": { - "description": "Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", + }, + "content": { + "application/json": { "schema": { - "type": "string", - "description": "FactSet's request key header." + "$ref": "#/components/schemas/ClientErrorResponse" } }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", + "application/x-protobuf": { "schema": { - "type": "string", - "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." + "$ref": "#/components/schemas/ClientErrorResponse" } } } }, - "503": { - "description": "Request timed out. Retry the request in sometime.", - "headers": { - "X-DataDirect-Request-Key": { - "description": "FactSet's request key header.", - "schema": { - "type": "string", - "description": "FactSet's request key header." - } - }, - "X-FactSet-Api-Request-Key": { - "description": "Key to uniquely identify an Analytics API 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.", + "404": { + "description": "One or more calculation settings were unavailable.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37264,10 +37261,22 @@ "type": "string" } } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + }, + "application/x-protobuf": { + "schema": { + "$ref": "#/components/schemas/ClientErrorResponse" + } + } } }, - "400": { - "description": "Invalid identifier provided.", + "409": { + "description": "Duplicate calculation exists with same parameters.", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37303,25 +37312,39 @@ } }, "content": { - "text/plain": { + "application/json": { "schema": { "$ref": "#/components/schemas/ClientErrorResponse" } }, - "application/json": { + "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." + } }, - "text/json": { + "X-FactSet-Api-Request-Key": { + "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication.", "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" + "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.", + "403": { + "description": "User is forbidden with current credentials", "headers": { "X-DataDirect-Request-Key": { "description": "FactSet's request key header.", @@ -37355,27 +37378,10 @@ "type": "string" } } - }, - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ClientErrorResponse" - } - } } }, - "401": { - "description": "Missing or invalid authentication.", + "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.", @@ -37390,11 +37396,29 @@ "type": "string", "description": "Key to uniquely identify an Analytics API request. Only available after successful authentication." } + }, + "X-FactSet-Api-RateLimit-Limit": { + "description": "Number of allowed requests for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Remaining": { + "description": "Number of requests left for the time window.", + "schema": { + "type": "string" + } + }, + "X-FactSet-Api-RateLimit-Reset": { + "description": "Number of seconds remaining till rate limit resets.", + "schema": { + "type": "string" + } } } }, - "403": { - "description": "User is forbidden with current credentials", + "429": { + "description": "Rate limit reached. 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.", @@ -37427,6 +37451,12 @@ "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" + } } } }, @@ -37469,23 +37499,29 @@ } } }, - "x-are-multiple-success-responses-different": false, + "x-are-multiple-success-responses-different": true, "x-success-response-types": [ { - "status-code": "204", - "response-type": null + "status-code": "202", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "200", + "response-type": "CalculationStatusRoot" + }, + { + "status-code": "201", + "response-type": "ObjectRoot" } ] - } - }, - "/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", + "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", @@ -37500,7 +37536,553 @@ ], "responses": { "200": { - "description": "Expected response once calculation is completed.", + "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.", @@ -38133,7 +38715,8 @@ "id": { "type": "string" } - } + }, + "additionalProperties": false }, "SPARAccounts": { "type": "object", @@ -38145,7 +38728,8 @@ }, "description": "List of SPAR returnsType" } - } + }, + "additionalProperties": false }, "SPARAccountsRoot": { "required": [ @@ -38156,10 +38740,9 @@ "data": { "$ref": "#/components/schemas/SPARAccounts" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ErrorSource": { "type": "object", @@ -38170,7 +38753,8 @@ "parameter": { "type": "string" } - } + }, + "additionalProperties": false }, "Error": { "type": "object", @@ -38184,7 +38768,8 @@ "source": { "$ref": "#/components/schemas/ErrorSource" } - } + }, + "additionalProperties": false }, "ClientErrorResponse": { "type": "object", @@ -38195,7 +38780,8 @@ "$ref": "#/components/schemas/Error" } } - } + }, + "additionalProperties": false }, "AccountDirectories": { "type": "object", @@ -38214,7 +38800,8 @@ }, "description": "List of directories." } - } + }, + "additionalProperties": false }, "AccountDirectoriesRoot": { "required": [ @@ -38225,10 +38812,9 @@ "data": { "$ref": "#/components/schemas/AccountDirectories" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "AFIOptimizerStrategyOverrides": { "type": "object", @@ -38260,7 +38846,8 @@ "type": "string", "description": "Transaction cost" } - } + }, + "additionalProperties": false }, "AFIOptimizerStrategy": { "required": [ @@ -38275,7 +38862,8 @@ "type": "string", "description": "OptimizerStrategy document path" } - } + }, + "additionalProperties": false }, "OptimizerAccountOverrides": { "type": "object", @@ -38296,7 +38884,8 @@ "type": "string", "description": "Currency" } - } + }, + "additionalProperties": false }, "OptimizerAccount": { "type": "object", @@ -38308,7 +38897,8 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - } + }, + "additionalProperties": false }, "Optimization": { "type": "object", @@ -38325,7 +38915,8 @@ "type": "string", "description": "Cash flow" } - } + }, + "additionalProperties": false }, "OptimizerTradesList": { "type": "object", @@ -38350,7 +38941,8 @@ "type": "boolean", "description": "Include cash" } - } + }, + "additionalProperties": false }, "OptimizerOptimalHoldings": { "type": "object", @@ -38379,7 +38971,8 @@ "type": "boolean", "description": "Exclude zero" } - } + }, + "additionalProperties": false }, "OptimalPortfolio": { "type": "object", @@ -38414,10 +39007,12 @@ "type": "string", "description": "Action if ofdb date exists" } - } + }, + "additionalProperties": false }, "OptimizerStats": { - "type": "object" + "type": "object", + "additionalProperties": false }, "OptimizerOutputTypes": { "type": "object", @@ -38434,7 +39029,8 @@ "stats": { "$ref": "#/components/schemas/OptimizerStats" } - } + }, + "additionalProperties": false }, "AFIOptimizationParameters": { "required": [ @@ -38455,10 +39051,12 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - } + }, + "additionalProperties": false }, "OptimizerCalculationMeta": { - "type": "object" + "type": "object", + "additionalProperties": false }, "AFIOptimizationParametersRoot": { "type": "object", @@ -38469,7 +39067,8 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - } + }, + "additionalProperties": false }, "CalculationInfo": { "type": "object", @@ -38478,7 +39077,8 @@ "type": "string", "description": "Calculation identifier" } - } + }, + "additionalProperties": false }, "CalculationInfoRoot": { "required": [ @@ -38489,10 +39089,9 @@ "data": { "$ref": "#/components/schemas/CalculationInfo" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ObjectRoot": { "required": [ @@ -38500,13 +39099,10 @@ ], "type": "object", "properties": { - "data": { - "type": "object" - }, - "meta": { - "type": "object" - } - } + "data": { }, + "meta": { } + }, + "additionalProperties": false }, "AxiomaEquityOptimizerStrategyOverrides": { "type": "object", @@ -38538,7 +39134,8 @@ "type": "string", "description": "Transaction cost" } - } + }, + "additionalProperties": false }, "AxiomaEquityOptimizerStrategy": { "required": [ @@ -38553,7 +39150,8 @@ "type": "string", "description": "OptimizerStrategy document path" } - } + }, + "additionalProperties": false }, "AxiomaEquityOptimizationParameters": { "required": [ @@ -38574,7 +39172,8 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - } + }, + "additionalProperties": false }, "AxiomaEquityOptimizationParametersRoot": { "type": "object", @@ -38585,7 +39184,8 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - } + }, + "additionalProperties": false }, "SPARIdentifier": { "required": [ @@ -38606,6 +39206,7 @@ "description": "Benchmark prefix." } }, + "additionalProperties": false, "description": "The account/benchmark parameter for SPAR calculation." }, "SPARBenchmark": { @@ -38626,7 +39227,8 @@ }, "description": "List of SPAR identifiers" } - } + }, + "additionalProperties": false }, "SPARBenchmarkRoot": { "required": [ @@ -38637,10 +39239,9 @@ "data": { "$ref": "#/components/schemas/SPARBenchmark" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ConstraintAction": { "type": "object", @@ -38655,7 +39256,8 @@ ], "type": "string" } - } + }, + "additionalProperties": false }, "BPMOptimizerStrategyAlphaOverride": { "type": "object", @@ -38676,7 +39278,8 @@ "returnMultiplier": { "type": "string" } - } + }, + "additionalProperties": false }, "BPMOptimizerStrategyOverrides": { "type": "object", @@ -38699,7 +39302,8 @@ "type": "string", "description": "Transaction cost\r\nCan be set to \"\" for local" } - } + }, + "additionalProperties": false }, "BPMOptimizerStrategy": { "required": [ @@ -38714,7 +39318,8 @@ "type": "string", "description": "OptimizerStrategy document path" } - } + }, + "additionalProperties": false }, "BPMOptimization": { "type": "object", @@ -38739,7 +39344,8 @@ "type": "string", "description": "Cash flow" } - } + }, + "additionalProperties": false }, "BPMOptimizationParameters": { "required": [ @@ -38760,7 +39366,8 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - } + }, + "additionalProperties": false }, "BPMOptimizationParametersRoot": { "type": "object", @@ -38771,7 +39378,8 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - } + }, + "additionalProperties": false }, "ColumnSummary": { "type": "object", @@ -38789,6 +39397,7 @@ "description": "Column Category" } }, + "additionalProperties": false, "description": "Column settings (name, directory, category)" }, "ColumnSummaryRoot": { @@ -38803,10 +39412,9 @@ "$ref": "#/components/schemas/ColumnSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "Column": { "type": "object", @@ -38830,7 +39438,8 @@ "type": "string", "description": "Column Category" } - } + }, + "additionalProperties": false }, "ColumnRoot": { "required": [ @@ -38841,10 +39450,9 @@ "data": { "$ref": "#/components/schemas/Column" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ColumnStatistic": { "type": "object", @@ -38853,7 +39461,8 @@ "type": "string", "description": "Column Statistic Name" } - } + }, + "additionalProperties": false }, "ColumnStatisticRoot": { "required": [ @@ -38867,10 +39476,9 @@ "$ref": "#/components/schemas/ColumnStatistic" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ComponentSummary": { "type": "object", @@ -38882,12 +39490,9 @@ "category": { "type": "string", "description": "Component category." - }, - "type": { - "type": "string", - "description": "Component type." } - } + }, + "additionalProperties": false }, "ComponentSummaryRoot": { "required": [ @@ -38901,10 +39506,9 @@ "$ref": "#/components/schemas/ComponentSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "PAIdentifier": { "required": [ @@ -38920,7 +39524,8 @@ "type": "string", "description": "Holdings Mode can be B&H, TBR, OMS or EXT." } - } + }, + "additionalProperties": false }, "PADateParameters": { "required": [ @@ -38942,6 +39547,7 @@ "description": "Calculation's frequency." } }, + "additionalProperties": false, "description": "The date parameters for PA calculation." }, "PAComponent": { @@ -38975,6 +39581,10 @@ "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." @@ -38982,12 +39592,9 @@ "category": { "type": "string", "description": "Component category." - }, - "type": { - "type": "string", - "description": "Component type." } - } + }, + "additionalProperties": false }, "PAComponentRoot": { "required": [ @@ -38998,10 +39605,9 @@ "data": { "$ref": "#/components/schemas/PAComponent" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "VaultIdentifier": { "required": [ @@ -39014,6 +39620,7 @@ "description": "User's FactSet account path OR benchmark." } }, + "additionalProperties": false, "description": "The account/benchmark parameter for Vault calculation." }, "VaultDateParameters": { @@ -39036,6 +39643,7 @@ "description": "Calculation's frequency." } }, + "additionalProperties": false, "description": "The date parameters for Vault calculation" }, "VaultComponent": { @@ -39062,6 +39670,10 @@ "type": "boolean", "description": "Snapshot" }, + "path": { + "type": "string", + "description": "The path to the document" + }, "name": { "type": "string", "description": "Component name." @@ -39069,12 +39681,9 @@ "category": { "type": "string", "description": "Component category." - }, - "type": { - "type": "string", - "description": "Component type." } - } + }, + "additionalProperties": false }, "VaultComponentRoot": { "required": [ @@ -39085,10 +39694,9 @@ "data": { "$ref": "#/components/schemas/VaultComponent" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "VaultConfigurationSummary": { "type": "object", @@ -39097,7 +39705,8 @@ "type": "string", "description": "Configuration name." } - } + }, + "additionalProperties": false }, "VaultConfigurationSummaryRoot": { "required": [ @@ -39111,10 +39720,9 @@ "$ref": "#/components/schemas/VaultConfigurationSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "ConfigurationAccount": { "type": "object", @@ -39143,7 +39751,8 @@ "type": "string", "description": "Account name." } - } + }, + "additionalProperties": false }, "VaultConfiguration": { "type": "object", @@ -39158,7 +39767,8 @@ "$ref": "#/components/schemas/ConfigurationAccount" } } - } + }, + "additionalProperties": false }, "VaultConfigurationRoot": { "required": [ @@ -39169,10 +39779,9 @@ "data": { "$ref": "#/components/schemas/VaultConfiguration" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "Currency": { "type": "object", @@ -39181,7 +39790,8 @@ "type": "string", "description": "Name of currency." } - } + }, + "additionalProperties": false }, "CurrencyRoot": { "required": [ @@ -39195,10 +39805,9 @@ "$ref": "#/components/schemas/Currency" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "DateParametersSummary": { "type": "object", @@ -39211,7 +39820,8 @@ "type": "string", "description": "End date in YYYYMMDD format." } - } + }, + "additionalProperties": false }, "DateParametersSummaryRoot": { "required": [ @@ -39222,10 +39832,9 @@ "data": { "$ref": "#/components/schemas/DateParametersSummary" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "DocumentDirectories": { "type": "object", @@ -39244,7 +39853,8 @@ }, "description": "List of directories." } - } + }, + "additionalProperties": false }, "DocumentDirectoriesRoot": { "required": [ @@ -39255,10 +39865,9 @@ "data": { "$ref": "#/components/schemas/DocumentDirectories" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "FIABIdentifier": { "required": [ @@ -39270,7 +39879,8 @@ "type": "string", "description": "User's FactSet account path." } - } + }, + "additionalProperties": false }, "FIABDateParameters": { "required": [ @@ -39288,6 +39898,7 @@ "description": "Calculation's end date." } }, + "additionalProperties": false, "description": "The date parameters for FIAB calculations." }, "FIABCalculationParameters": { @@ -39315,7 +39926,8 @@ "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", @@ -39330,7 +39942,8 @@ "description": "Last poll time of calculation.", "format": "date-time" } - } + }, + "additionalProperties": false }, "EventSummary": { "type": "object", @@ -39348,7 +39961,8 @@ "type": "string", "description": "Event's type" } - } + }, + "additionalProperties": false }, "FIABCalculationStatus": { "type": "object", @@ -39391,7 +40005,68 @@ }, "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 + }, + "FILoss": { + "type": "object", + "properties": { + "lossName": { + "type": "string", + "description": "Loss Name" + } + }, + "additionalProperties": false + }, + "FIPrepay": { + "type": "object", + "properties": { + "prepayName": { + "type": "string", + "description": "Prepay Name" + } + }, + "additionalProperties": false }, "FISecurity": { "required": [ @@ -39414,9 +40089,28 @@ "type": "string", "description": "Call Method" }, + "referenceSecurity": { + "$ref": "#/components/schemas/FIReferenceSecurity" + }, + "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" + }, "calcFromMethod": { "type": "string", - "description": "Calculation from method" + "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", @@ -39446,7 +40140,8 @@ "type": "string", "description": "Discount curve" } - } + }, + "additionalProperties": false }, "FIJobSettings": { "required": [ @@ -39482,9 +40177,10 @@ }, "calcFromMethod": { "type": "string", - "description": "Calculation from method" + "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" } - } + }, + "additionalProperties": false }, "FICalculationParameters": { "required": [ @@ -39511,7 +40207,8 @@ "jobSettings": { "$ref": "#/components/schemas/FIJobSettings" } - } + }, + "additionalProperties": false }, "CalculationMeta": { "type": "object", @@ -39561,7 +40258,8 @@ "type": "string", "default": "JsonStach" } - } + }, + "additionalProperties": false }, "FICalculationParametersRoot": { "type": "object", @@ -39572,7 +40270,8 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - } + }, + "additionalProperties": false }, "PaDoc": { "required": [ @@ -39584,7 +40283,8 @@ "type": "string", "description": "PA document path" } - } + }, + "additionalProperties": false }, "FPOAccount": { "required": [ @@ -39602,14 +40302,33 @@ "overrides": { "$ref": "#/components/schemas/OptimizerAccountOverrides" } - } + }, + "additionalProperties": false }, - "OptimizerStrategyOverrides": { + "FPOObjective": { "type": "object", "properties": { - "tax": { - "type": "string", - "description": "Tax" + "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", @@ -39630,22 +40349,24 @@ "type": "string", "description": "Transaction cost" } - } + }, + "additionalProperties": false }, - "OptimizerStrategy": { + "FPOOptimizerStrategy": { "required": [ "id" ], "type": "object", "properties": { + "overrides": { + "$ref": "#/components/schemas/FPOOptimizerStrategyOverrides" + }, "id": { "type": "string", "description": "OptimizerStrategy document path" - }, - "overrides": { - "$ref": "#/components/schemas/OptimizerStrategyOverrides" } - } + }, + "additionalProperties": false }, "FPOOptimizationParameters": { "required": [ @@ -39658,7 +40379,7 @@ "$ref": "#/components/schemas/FPOAccount" }, "strategy": { - "$ref": "#/components/schemas/OptimizerStrategy" + "$ref": "#/components/schemas/FPOOptimizerStrategy" }, "optimization": { "$ref": "#/components/schemas/Optimization" @@ -39666,7 +40387,8 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - } + }, + "additionalProperties": false }, "FPOOptimizationParametersRoot": { "type": "object", @@ -39677,7 +40399,8 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - } + }, + "additionalProperties": false }, "Frequency": { "type": "object", @@ -39686,7 +40409,8 @@ "type": "string", "description": "Frequency name." } - } + }, + "additionalProperties": false }, "FrequencyRoot": { "required": [ @@ -39700,10 +40424,9 @@ "$ref": "#/components/schemas/Frequency" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "Group": { "type": "object", @@ -39720,7 +40443,8 @@ "type": "string", "description": "Group Category" } - } + }, + "additionalProperties": false }, "GroupRoot": { "required": [ @@ -39734,10 +40458,9 @@ "$ref": "#/components/schemas/Group" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "TemplateContentTypes": { "type": "object", @@ -39763,7 +40486,8 @@ }, "description": "Template locked fields" } - } + }, + "additionalProperties": false }, "LinkedPATemplateParameters": { "required": [ @@ -39787,7 +40511,8 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - } + }, + "additionalProperties": false }, "LinkedPATemplateParametersRoot": { "required": [ @@ -39798,10 +40523,44 @@ "data": { "$ref": "#/components/schemas/LinkedPATemplateParameters" }, - "meta": { - "type": "object" + "meta": { } + }, + "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": { } + }, + "additionalProperties": false }, "LinkedPATemplateSummary": { "type": "object", @@ -39818,7 +40577,8 @@ "type": "string", "description": "Template parent tile." } - } + }, + "additionalProperties": false }, "LinkedPATemplateSummaryRoot": { "required": [ @@ -39832,10 +40592,9 @@ "$ref": "#/components/schemas/LinkedPATemplateSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "LinkedPATemplateUpdateParameters": { "type": "object", @@ -39851,7 +40610,8 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - } + }, + "additionalProperties": false }, "LinkedPATemplateUpdateParametersRoot": { "required": [ @@ -39862,10 +40622,9 @@ "data": { "$ref": "#/components/schemas/LinkedPATemplateUpdateParameters" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "LinkedPATemplate": { "type": "object", @@ -39897,7 +40656,8 @@ "type": "string", "description": "Template parent tile." } - } + }, + "additionalProperties": false }, "LinkedPATemplateRoot": { "required": [ @@ -39908,19 +40668,16 @@ "data": { "$ref": "#/components/schemas/LinkedPATemplate" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "NPOOptimizerStrategyOverrides": { "type": "object", "properties": { "objective": { "type": "object", - "additionalProperties": { - "type": "object" - }, + "additionalProperties": { }, "description": "Objective parameters" }, "constraints": { @@ -39942,7 +40699,8 @@ "type": "string", "description": "Alpha" } - } + }, + "additionalProperties": false }, "NPOOptimizerStrategy": { "required": [ @@ -39957,7 +40715,8 @@ "type": "string", "description": "OptimizerStrategy document path" } - } + }, + "additionalProperties": false }, "NPOOptimizationParameters": { "required": [ @@ -39978,7 +40737,8 @@ "outputTypes": { "$ref": "#/components/schemas/OptimizerOutputTypes" } - } + }, + "additionalProperties": false }, "NPOOptimizationParametersRoot": { "type": "object", @@ -39989,7 +40749,8 @@ "meta": { "$ref": "#/components/schemas/OptimizerCalculationMeta" } - } + }, + "additionalProperties": false }, "PACalculationGroup": { "type": "object", @@ -39998,7 +40759,8 @@ "type": "string", "description": "FactSet-defined or User-defined Group identifier." } - } + }, + "additionalProperties": false }, "PACalculationColumn": { "type": "object", @@ -40014,7 +40776,8 @@ }, "description": "Column Statistic identifier" } - } + }, + "additionalProperties": false }, "PACalculationParameters": { "required": [ @@ -40063,9 +40826,10 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the PA component. It can be GROUPS or TOTALS." + "description": "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES." } - } + }, + "additionalProperties": false }, "PACalculationParametersRoot": { "type": "object", @@ -40080,7 +40844,8 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - } + }, + "additionalProperties": false }, "CalculationUnitStatus": { "type": "object", @@ -40110,8 +40875,14 @@ "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", @@ -40127,125 +40898,376 @@ "Completed", "Cancelled" ], - "type": "string", - "description": "Calculation's status" - }, - "units": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CalculationUnitStatus" - }, - "description": "Number of calculation units in batch." + "type": "string", + "description": "Calculation's status" + }, + "units": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/CalculationUnitStatus" + }, + "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 + }, + "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": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "QuantUniverse": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - } + }, + "additionalProperties": false }, - "CalculationUnitStatusMeta": { + "QuantUniversalScreenUniverse": { + "required": [ + "screen" + ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantUniverse" + } + ], "properties": { - "info": { - "type": "string", - "description": "The Info URL of the calculation." + "screen": { + "type": "string" } - } + }, + "additionalProperties": false }, - "CalculationStatusMeta": { + "QuantDateList": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantDate" + } + ], "properties": { - "units": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/CalculationUnitStatusMeta" - }, - "description": "Meta of calculation units in batch." + "dates": { + "type": "array", + "items": { + "type": "string" + } } - } + }, + "additionalProperties": false }, - "CalculationStatusRoot": { + "QuantDate": { "required": [ - "data" + "calendar", + "frequency", + "source" ], "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/CalculationStatus" + "source": { + "enum": [ + "FdsDate", + "DateList" + ], + "type": "string" }, - "meta": { - "$ref": "#/components/schemas/CalculationStatusMeta" + "frequency": { + "type": "string" + }, + "calendar": { + "type": "string" } - } + }, + "additionalProperties": false }, - "PubIdentifier": { + "QuantFdsDate": { "required": [ - "id" + "endDate", + "startDate" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantDate" + } + ], "properties": { - "id": { - "type": "string", - "description": "User's FactSet account path OR benchmark." + "startDate": { + "type": "string" }, - "holdingsmode": { - "type": "string", - "description": "Holdings Mode can be B&H, TBR, OMS or EXT." + "endDate": { + "type": "string" } - } + }, + "additionalProperties": false }, - "PubDateParameters": { + "QuantFqlExpression": { "required": [ - "enddate" + "expr", + "name" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ], "properties": { - "startdate": { - "type": "string", - "description": "Calculation's start date." + "expr": { + "type": "string" }, - "enddate": { - "type": "string", - "description": "Calculation's end date or as of date." + "name": { + "type": "string" } }, - "description": "The date parameters for Publisher calculation." + "additionalProperties": false }, - "PubCalculationParameters": { + "QuantUniversalScreenParameter": { "required": [ - "account", - "dates", - "document" + "name", + "referenceName" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ], "properties": { - "document": { - "type": "string", - "description": "The Publisher Engine document to analyze." - }, - "account": { - "$ref": "#/components/schemas/PubIdentifier" + "referenceName": { + "type": "string" }, - "dates": { - "$ref": "#/components/schemas/PubDateParameters" + "name": { + "type": "string" } - } + }, + "additionalProperties": false }, - "PubCalculationMeta": { - "type": "object" + "QuantAllUniversalScreenParameters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ], + "additionalProperties": false }, - "PubCalculationParametersRoot": { + "QuantFormula": { + "required": [ + "source" + ], "type": "object", "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/PubCalculationParameters" - }, - "description": "List of calculation parameters." + "source": { + "enum": [ + "ScreeningExpression", + "FqlExpression", + "UniversalScreenParameter", + "AllUniversalScreenParameters" + ], + "type": "string" + } + }, + "additionalProperties": false + }, + "QuantScreeningExpression": { + "required": [ + "expr", + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/QuantFormula" + } + ], + "properties": { + "expr": { + "type": "string" }, - "meta": { - "$ref": "#/components/schemas/PubCalculationMeta" + "name": { + "type": "string" } - } + }, + "additionalProperties": false }, - "QuantScreeningExpressionUniverse": { + "QuantScreeningExpressionUniverseObsolete": { "required": [ "universeExpr", "universeType" @@ -40264,10 +41286,19 @@ }, "securityExpr": { "type": "string" + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - } + }, + "additionalProperties": false }, - "QuantUniversalScreenUniverse": { + "QuantUniversalScreenUniverseObsolete": { "required": [ "screen" ], @@ -40275,10 +41306,19 @@ "properties": { "screen": { "type": "string" + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - } + }, + "additionalProperties": false }, - "QuantIdentifierUniverse": { + "QuantIdentifierUniverseObsolete": { "required": [ "identifiers", "universeType" @@ -40297,10 +41337,19 @@ "items": { "type": "string" } + }, + "source": { + "enum": [ + "ScreeningExpressionUniverse", + "UniversalScreenUniverse", + "IdentifierUniverse" + ], + "type": "string" } - } + }, + "additionalProperties": false }, - "QuantFdsDate": { + "QuantFdsDateObsolete": { "required": [ "calendar", "endDate", @@ -40321,9 +41370,10 @@ "calendar": { "type": "string" } - } + }, + "additionalProperties": false }, - "QuantDateList": { + "QuantDateListObsolete": { "required": [ "calendar", "frequency" @@ -40342,9 +41392,10 @@ "calendar": { "type": "string" } - } + }, + "additionalProperties": false }, - "QuantScreeningExpression": { + "QuantScreeningExpressionObsolete": { "required": [ "expr", "name" @@ -40357,9 +41408,10 @@ "name": { "type": "string" } - } + }, + "additionalProperties": false }, - "QuantFqlExpression": { + "QuantFqlExpressionObsolete": { "required": [ "expr", "name" @@ -40372,9 +41424,10 @@ "name": { "type": "string" } - } + }, + "additionalProperties": false }, - "QuantUniversalScreenParameter": { + "QuantUniversalScreenParameterObsolete": { "required": [ "name", "referenceName" @@ -40387,55 +41440,97 @@ "name": { "type": "string" } - } - }, - "QuantAllUniversalScreenParameters": { - "type": "object" + }, + "additionalProperties": false }, - "QuantCalculationParameters": { + "QuantAllUniversalScreenParametersObsolete": { "type": "object", - "properties": { - "screeningExpressionUniverse": { - "$ref": "#/components/schemas/QuantScreeningExpressionUniverse" - }, - "universalScreenUniverse": { + "additionalProperties": false + }, + "OneOfQuantUniverse": { + "oneOf": [ + { "$ref": "#/components/schemas/QuantUniversalScreenUniverse" }, - "identifierUniverse": { - "$ref": "#/components/schemas/QuantIdentifierUniverse" + { + "$ref": "#/components/schemas/QuantScreeningExpressionUniverse" }, - "fdsDate": { + { + "$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" }, - "dateList": { + { "$ref": "#/components/schemas/QuantDateList" + } + ], + "discriminator": { + "propertyName": "source", + "mapping": { + "FdsDate": "#/components/schemas/QuantFdsDate", + "DateList": "#/components/schemas/QuantDateList" + } + } + }, + "OneOfQuantFormulasArray": { + "oneOf": [ + { + "$ref": "#/components/schemas/QuantScreeningExpression" }, - "screeningExpression": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuantScreeningExpression" - } - }, - "fqlExpression": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuantFqlExpression" - } + { + "$ref": "#/components/schemas/QuantFqlExpression" }, - "universalScreenParameter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuantUniversalScreenParameter" - } + { + "$ref": "#/components/schemas/QuantUniversalScreenParameter" }, - "allUniversalScreenParameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuantAllUniversalScreenParameters" - } + { + "$ref": "#/components/schemas/QuantAllUniversalScreenParameters" + } + ], + "discriminator": { + "propertyName": "source", + "mapping": { + "ScreeningExpression": "#/components/schemas/QuantScreeningExpression", + "FqlExpression": "#/components/schemas/QuantFqlExpression", + "UniversalScreenParameter": "#/components/schemas/QuantUniversalScreenParameter", + "AllUniversalScreenParameters": "#/components/schemas/QuantAllUniversalScreenParameters" } } }, + "OneOfQuantFormulas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OneOfQuantFormulasArray" + } + }, + "QuantCalculationParameters": { + "type": "object", + "properties": { + "universe": { + "$ref": "#/components/schemas/OneOfQuantUniverse" + }, + "dates": { + "$ref": "#/components/schemas/OneOfQuantDates" + }, + "formulas": { + "$ref": "#/components/schemas/OneOfQuantFormulas" + } + }, + "additionalProperties": false + }, "QuantCalculationMeta": { "type": "object", "properties": { @@ -40487,7 +41582,8 @@ "type": "string", "default": "JsonStach" } - } + }, + "additionalProperties": false }, "QuantCalculationParametersRoot": { "type": "object", @@ -40502,7 +41598,8 @@ "meta": { "$ref": "#/components/schemas/QuantCalculationMeta" } - } + }, + "additionalProperties": false }, "SPARDateParameters": { "required": [ @@ -40525,6 +41622,7 @@ "description": "Calculation's frequency." } }, + "additionalProperties": false, "description": "The date parameters for SPAR calculation." }, "SPARCalculationParameters": { @@ -40554,7 +41652,8 @@ "type": "string", "description": "Currency ISO code for calculation." } - } + }, + "additionalProperties": false }, "SPARCalculationParametersRoot": { "type": "object", @@ -40569,7 +41668,8 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - } + }, + "additionalProperties": false }, "PAComponentData": { "type": "object", @@ -40613,7 +41713,8 @@ "type": "string", "description": "PA Storage type. It can be GROUPS or TOTALS or SECURITIES." } - } + }, + "additionalProperties": false }, "TemplatedPAComponentParameters": { "required": [ @@ -40637,7 +41738,8 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - } + }, + "additionalProperties": false }, "TemplatedPAComponentParametersRoot": { "required": [ @@ -40648,10 +41750,43 @@ "data": { "$ref": "#/components/schemas/TemplatedPAComponentParameters" }, - "meta": { - "type": "object" + "meta": { } + }, + "additionalProperties": false + }, + "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": { } + }, + "additionalProperties": false }, "TemplatedPAComponentSummary": { "type": "object", @@ -40668,7 +41803,8 @@ "type": { "type": "string" } - } + }, + "additionalProperties": false }, "TemplatedPAComponentSummaryRoot": { "required": [ @@ -40682,10 +41818,9 @@ "$ref": "#/components/schemas/TemplatedPAComponentSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "TemplatedPAComponentUpdateParameters": { "type": "object", @@ -40701,7 +41836,8 @@ "componentData": { "$ref": "#/components/schemas/PAComponentData" } - } + }, + "additionalProperties": false }, "TemplatedPAComponentUpdateParametersRoot": { "required": [ @@ -40712,10 +41848,52 @@ "data": { "$ref": "#/components/schemas/TemplatedPAComponentUpdateParameters" }, - "meta": { - "type": "object" + "meta": { } + }, + "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" } - } + }, + "additionalProperties": false + }, + "TemplatedPAComponentRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TemplatedPAComponent" + }, + "meta": { } + }, + "additionalProperties": false }, "UnlinkedPATemplateParameters": { "required": [ @@ -40778,7 +41956,8 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateParametersRoot": { "required": [ @@ -40789,24 +41968,62 @@ "data": { "$ref": "#/components/schemas/UnlinkedPATemplateParameters" }, - "meta": { - "type": "object" + "meta": { } + }, + "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" } - } + }, + "additionalProperties": false + }, + "UnlinkedPATemplatePostSummaryRoot": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UnlinkedPATemplatePostSummary" + }, + "meta": { } + }, + "additionalProperties": false }, "UnlinkedPATemplateSummary": { "type": "object", "properties": { "description": { - "type": "string" + "type": "string", + "description": "Template description." }, "name": { - "type": "string" + "type": "string", + "description": "Template name." }, "category": { - "type": "string" + "type": "string", + "description": "Unlinked template category" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateSummaryRoot": { "required": [ @@ -40820,10 +42037,9 @@ "$ref": "#/components/schemas/UnlinkedPATemplateSummary" } }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "UnlinkedPATemplateUpdateParameters": { "type": "object", @@ -40874,7 +42090,8 @@ "content": { "$ref": "#/components/schemas/TemplateContentTypes" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateUpdateParametersRoot": { "required": [ @@ -40885,43 +42102,49 @@ "data": { "$ref": "#/components/schemas/UnlinkedPATemplateUpdateParameters" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "UnlinkedPATemplate": { "type": "object", "properties": { - "directory": { - "type": "string" - }, "id": { - "type": "string" + "type": "string", + "description": "Template id." + }, + "directory": { + "type": "string", + "description": "Template directory." }, "templateTypeId": { - "type": "string" + "type": "string", + "description": "Template type id" }, "snapshot": { - "type": "boolean" + "type": "boolean", + "description": "snapshot." }, "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" @@ -40930,27 +42153,34 @@ "type": "array", "items": { "$ref": "#/components/schemas/PACalculationGroup" - } + }, + "description": "List of groupings for the PA calculation" }, "currencyisocode": { - "type": "string" + "type": "string", + "description": "Currency ISO code for calculation." }, "componentdetail": { - "type": "string" + "type": "string", + "description": "PA storage type. It can be GROUPS or TOTALS or SECURITIES." }, "content": { "$ref": "#/components/schemas/TemplateContentTypes" }, "description": { - "type": "string" + "type": "string", + "description": "Template description." }, "name": { - "type": "string" + "type": "string", + "description": "Template name." }, "category": { - "type": "string" + "type": "string", + "description": "Unlinked template category" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateRoot": { "required": [ @@ -40961,10 +42191,9 @@ "data": { "$ref": "#/components/schemas/UnlinkedPATemplate" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "UnlinkedPATemplateCategoryAndType": { "type": "object", @@ -40977,7 +42206,8 @@ "type": "string", "description": "Unlinked template type" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateCategoryAndTypeRoot": { "required": [ @@ -40991,10 +42221,44 @@ "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndType" } }, - "meta": { - "type": "object" + "meta": { } + }, + "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" + }, + "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." + } + }, + "additionalProperties": false }, "UnlinkedPATemplateCategoryAndTypeDetails": { "type": "object", @@ -41003,6 +42267,24 @@ "type": "string", "description": "Type Id" }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnlinkedPATemplateColumnDetails" + }, + "description": "List of default columns" + }, + "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" @@ -41011,7 +42293,8 @@ "type": "string", "description": "Unlinked template type" } - } + }, + "additionalProperties": false }, "UnlinkedPATemplateCategoryAndTypeDetailsRoot": { "required": [ @@ -41022,10 +42305,9 @@ "data": { "$ref": "#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails" }, - "meta": { - "type": "object" - } - } + "meta": { } + }, + "additionalProperties": false }, "VaultCalculationParameters": { "required": [ @@ -41051,9 +42333,10 @@ }, "componentdetail": { "type": "string", - "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS." + "description": "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES." } - } + }, + "additionalProperties": false }, "VaultCalculationParametersRoot": { "type": "object", @@ -41068,7 +42351,8 @@ "meta": { "$ref": "#/components/schemas/CalculationMeta" } - } + }, + "additionalProperties": false } }, "securitySchemes": {