openapi: 3.0.3 info: title: Factset Analytics Datastore About Templates API description: Allow clients to fetch precalculated Analytics through predeterministic URLs. contact: name: FactSet Research Systems url: https://developer.factset.com/contact email: api@factset.com license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.0.0 servers: - url: https://api.factset.com description: Production - url: https://api-sandbox.factset.com description: Sandbox security: - basicAuth: [] tags: - name: Templates paths: /analytics/engines/pa/v3/linked-templates: post: tags: - Templates summary: Factset Create a Linked Pa Template description: "This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint." operationId: createLinkedPATemplates requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplateParametersRoot' example: data: directory: Personal:LinkedPATemplates/ parentComponentId: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46 description: This is a linked PA template that only returns security level data content: mandatory: - accounts - benchmarks optional: - groups - columns locked: - componentdetail required: true responses: '201': description: Expected response, created a template linked to a PA3 tile. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '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 '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Templates summary: Factset Get Linked Pa Templates description: This endpoint returns the list of linked PA templates in given path. operationId: getLinkedPATemplates parameters: - name: directory in: query description: Get linked PA templates in path. schema: type: string description: Get linked PA templates in path. example: Personal:LinkedPATemplates/ - name: documentDirectory in: query description: Get linked PA templates for documents in document path schema: type: string description: Get linked PA templates for documents in document path - name: documentName in: query description: Get linked PA templates for documents by document name schema: type: string description: Get linked PA templates for documents by document name responses: '200': description: Expected response, returns a list of templates linked to PA3 tile. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplateSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Document not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/linked-templates/{id}: put: tags: - Templates summary: Factset Update a Linked Pa Template description: "This endpoint allows the user to change the request body and description from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint." operationId: updateLinkedPATemplates parameters: - name: id in: path description: Unique identifier for a linked PA template required: true schema: type: string description: Unique identifier for a linked PA template example: 01234567890123456789012345678901 requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplateUpdateParametersRoot' example: data: parentComponentId: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46 description: This is a linked PA template that only returns security level data content: mandatory: - accounts - benchmarks optional: - groups - columns locked: - componentdetail required: true responses: '200': description: Expected response, updated a template linked to a PA3 tile. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Template or component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Templates summary: Factset Delete a Linked Pa Template. description: This endpoint deletes an existing linked PA template. operationId: deleteLinkedPATemplates parameters: - name: id in: path description: Unique identifier for a linked PA template required: true schema: type: string description: Unique identifier for a linked PA template example: 01234567890123456789012345678901 responses: '204': description: Expected response, deleted the linked PA template successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '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' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Templates summary: Factset Get Linked Pa Template by Id description: This endpoint fetches the linked PA template settings. operationId: getLinkedPATemplatesById parameters: - name: id in: path description: Unique identifier for a linked PA template required: true schema: type: string description: Unique identifier for a linked PA template example: 01234567890123456789012345678901 responses: '200': description: Expected response, linked PA template details. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/LinkedPATemplateRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string 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 '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' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/unlinked-templates: post: tags: - Templates summary: Factset Create Unlinked Pa Template description: "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also \r\n overriding the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component." operationId: createUnlinkedPATemplates requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot' example: data: directory: Personal:UnlinkedPATemplates/ templateTypeId: 996E90B981AEE83F14029ED3D309FB3F03EC6E2ACC7FD42C22CBD5D279502CFD description: This is an unlinked PA template that only returns security level data accounts: - id: SPN:SP50 holdingsmode: B&H - id: MSCI_USA:984000 holdingsmode: B&H benchmarks: - id: SPN:SP50 holdingsmode: B&H - id: DJGX:AMERICAS holdingsmode: B&H columns: - id: BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0 statistics: - eb9d6d91416e4224bacadc261787e56f dates: startdate: '20200101' enddate: '20201215' frequency: Monthly groups: - id: 5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA frequency: BeginningOfPeriod datasources: portfoliopricingsources: - id: 39A1C0C7BD46731552B29D913804EC5F3ED91E6B991AF298DEC88CCA2A9FC6B3 benchmarkpricingsources: - id: 9BB2A3142C450AF54A7486C1D37A210A64474B2499A1E4A30E19801B9FC55E8C useportfoliopricingsourcesforbenchmark: false currencyisocode: USD componentdetail: GROUPS content: mandatory: - accounts - benchmarks optional: - groups - columns locked: - dates required: true responses: '201': description: Expected response, created a unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Templates summary: Factset Get Unlinked Pa Templates description: This endpoint returns the list of unlinked PA templates. operationId: getUnlinkedPATemplates parameters: - name: directory in: query description: Get unlinked PA templates in path. schema: type: string description: Get unlinked PA templates in path. example: Personal:UninkedPATemplates/ - name: category in: query description: Get unlinked PA templates by category. schema: type: string description: Get unlinked PA templates by category. example: Weights responses: '200': description: Expected response, returns a list of unlinked PA templates. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/unlinked-templates/{id}: put: tags: - Templates summary: Factset Update Unlinked Pa Template description: "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component." operationId: updateUnlinkedPATemplates parameters: - name: id in: path description: Unique identifier for an unlinked PA template required: true schema: type: string description: Unique identifier for an unlinked PA template example: 01234567890123456789012345678901 requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot' example: data: description: This is an unlinked PA template that only returns security level data accounts: - id: SPN:SP50 holdingsmode: B&H - id: MSCI_USA:984000 holdingsmode: B&H benchmarks: - id: SPN:SP50 holdingsmode: B&H - id: DJGX:AMERICAS holdingsmode: B&H columns: - id: BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0 statistics: - eb9d6d91416e4224bacadc261787e56f dates: startdate: '20200101' enddate: '20201215' frequency: Monthly groups: - id: 5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA frequency: BeginningOfPeriod datasources: portfoliopricingsources: - id: 39A1C0C7BD46731552B29D913804EC5F3ED91E6B991AF298DEC88CCA2A9FC6B3 benchmarkpricingsources: - id: 9BB2A3142C450AF54A7486C1D37A210A64474B2499A1E4A30E19801B9FC55E8C useportfoliopricingsourcesforbenchmark: false currencyisocode: USD componentdetail: GROUPS content: mandatory: - accounts - benchmarks optional: - columns locked: - groups required: true responses: '200': description: Expected response, updated the unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Templates summary: Factset Delete Unlinked Pa Template description: This endpoint deletes an existing unliked PA template. operationId: deleteUnlinkedPATemplates parameters: - name: id in: path description: Unique identifier for an unlinked PA template required: true schema: type: string description: Unique identifier for an unlinked PA template example: 01234567890123456789012345678901 responses: '204': description: Expected response, deleted the unlinked PA template successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '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' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Templates summary: Factset Get Unlinked Pa Template Details by Id description: This endpoint fetches the template settings. operationId: getUnlinkedPATemplatesById parameters: - name: id in: path description: Unique identifier for an unlinked PA template required: true schema: type: string description: Unique identifier for an unlinked PA template example: 01234567890123456789012345678901 responses: '200': description: Expected response, get details of the unlinked PA template. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/unlinked-templates/template-types: get: tags: - Templates summary: Factset Get Default Unlinked Pa Template Types. description: This endpoint fetches default unlinked PA template types. operationId: getDefaultUnlinkedPATemplateTypes responses: '200': description: Expected response, default unlinked PA template types headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/unlinked-templates/template-types/{id}: get: tags: - Templates summary: Factset Get Unlinked Pa Template Type Details by Id. description: This endpoint fetches the unlinked PA template type details. operationId: getDetailsType parameters: - name: id in: path description: Unique identifier for an unlinked PA template type required: true schema: type: string description: Unique identifier for an unlinked PA template type responses: '200': description: Expected response, details of the unlinked PA template type headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Unlinked PA template type not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: PACalculationPricingSource: type: object properties: id: type: string description: Pricing source identifier nullable: true example: abc123 UnlinkedPATemplateCategoryAndTypeDetailsRoot: required: - data type: object properties: data: $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails' meta: nullable: true example: example_value LinkedPATemplateRoot: required: - data type: object properties: data: $ref: '#/components/schemas/LinkedPATemplate' meta: nullable: true example: example_value LinkedPATemplateUpdateParameters: type: object properties: parentComponentId: type: string description: Parent component id nullable: true example: '500123' description: type: string description: Template description nullable: true example: A sample description. content: $ref: '#/components/schemas/TemplateContentTypes' LinkedPATemplateUpdateParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/LinkedPATemplateUpdateParameters' meta: nullable: true example: example_value UnlinkedPATemplateColumnDetails: type: object properties: name: type: string description: Unlinked template column name nullable: true example: Example Title id: type: string description: FactSet-defined or User-defined Column identifier. nullable: true example: abc123 statistics: type: array items: type: string description: Column Statistic identifier nullable: true example: [] UnlinkedPATemplatePostSummary: type: object properties: id: type: string description: Template id. nullable: true example: abc123 description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title category: type: string description: Unlinked template category nullable: true example: example_value UnlinkedPATemplateCategoryAndTypeRoot: required: - data type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndType' example: example_value meta: nullable: true example: example_value UnlinkedPATemplateCategoryAndType: type: object properties: category: type: string description: Unlinked template category nullable: true example: example_value name: type: string description: Unlinked template type nullable: true example: Example Title LinkedPATemplatePostSummaryRoot: required: - data type: object properties: data: $ref: '#/components/schemas/LinkedPATemplatePostSummary' meta: nullable: true example: example_value UnlinkedPATemplatePostSummaryRoot: required: - data type: object properties: data: $ref: '#/components/schemas/UnlinkedPATemplatePostSummary' meta: nullable: true example: example_value Error: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource' UnlinkedPATemplateCategoryAndTypeDetails: type: object properties: id: type: string description: Type Id nullable: true example: abc123 columns: type: array items: $ref: '#/components/schemas/UnlinkedPATemplateColumnDetails' description: List of default columns nullable: true example: [] groups: type: array items: $ref: '#/components/schemas/UnlinkedPATemplateGroupDetails' description: List of default groupings nullable: true example: [] snapshot: type: boolean description: Snapshot example: true category: type: string description: Unlinked template category nullable: true example: example_value name: type: string description: Unlinked template type nullable: true example: Example Title PADateParameters: required: - enddate - frequency type: object properties: startdate: type: string description: Calculation's start date. nullable: true example: example_value enddate: type: string description: Calculation's end date. example: example_value frequency: type: string description: Calculation's frequency. example: example_value description: The date parameters for PA calculation. LinkedPATemplateSummary: type: object properties: description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title parentComponentId: type: string description: Template parent tile. nullable: true example: '500123' PACalculationColumn: type: object properties: id: type: string description: FactSet-defined or User-defined Column identifier. nullable: true example: abc123 statistics: type: array items: type: string description: Column Statistic identifier nullable: true example: [] LinkedPATemplate: type: object properties: directory: type: string description: Template directory. nullable: true example: example_value snapshot: type: boolean description: snapshot. example: true content: $ref: '#/components/schemas/TemplateContentTypes' id: type: string description: Template id. nullable: true example: abc123 description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title parentComponentId: type: string description: Template parent tile. nullable: true example: '500123' ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' nullable: true example: [] UnlinkedPATemplateRoot: required: - data type: object properties: data: $ref: '#/components/schemas/UnlinkedPATemplate' meta: nullable: true example: example_value PAIdentifier: required: - id type: object properties: id: type: string description: User's FactSet account path OR benchmark. example: abc123 holdingsmode: type: string description: Holdings Mode can be B&H, TBR, OMS, EXT or VLT. nullable: true example: example_value TemplateContentTypes: type: object properties: mandatory: type: array items: type: string description: Template mandatory fields nullable: true example: [] optional: type: array items: type: string description: Template optional fields nullable: true example: [] locked: type: array items: type: string description: Template locked fields nullable: true example: [] UnlinkedPATemplateParameters: required: - directory - templateTypeId type: object properties: directory: type: string description: The directory to create an unlinked PA template example: example_value templateTypeId: type: string description: Template type id example: '500123' description: type: string description: Template description nullable: true example: A sample description. accounts: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of accounts nullable: true example: [] benchmarks: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of benchmarks nullable: true example: [] columns: type: array items: $ref: '#/components/schemas/PACalculationColumn' description: List of columns for the PA calculation nullable: true example: [] dates: $ref: '#/components/schemas/PADateParameters' groups: type: array items: $ref: '#/components/schemas/PACalculationGroup' description: List of groupings for the PA calculation nullable: true example: [] datasources: $ref: '#/components/schemas/PACalculationDataSources' currencyisocode: type: string description: Currency ISO code for calculation. nullable: true example: example_value componentdetail: type: string description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. nullable: true example: example_value content: $ref: '#/components/schemas/TemplateContentTypes' LinkedPATemplateParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/LinkedPATemplateParameters' meta: nullable: true example: example_value ErrorSource: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value PACalculationGroup: type: object properties: id: type: string description: FactSet-defined or User-defined Group identifier. nullable: true example: abc123 frequency: type: string description: Grouping frequency nullable: true example: example_value UnlinkedPATemplateUpdateParameters: type: object properties: description: type: string description: Template description nullable: true example: A sample description. accounts: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of accounts nullable: true example: [] benchmarks: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of benchmarks nullable: true example: [] columns: type: array items: $ref: '#/components/schemas/PACalculationColumn' description: List of columns for the PA calculation nullable: true example: [] dates: $ref: '#/components/schemas/PADateParameters' groups: type: array items: $ref: '#/components/schemas/PACalculationGroup' description: List of groupings for the PA calculation nullable: true example: [] datasources: $ref: '#/components/schemas/PACalculationDataSources' currencyisocode: type: string description: Currency ISO code for calculation. nullable: true example: example_value componentdetail: type: string description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. nullable: true example: example_value content: $ref: '#/components/schemas/TemplateContentTypes' LinkedPATemplatePostSummary: type: object properties: id: type: string description: Template id. nullable: true example: abc123 description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title parentComponentId: type: string description: Template parent tile. nullable: true example: '500123' UnlinkedPATemplateGroupDetails: type: object properties: name: type: string description: Unlinked template group name nullable: true example: Example Title id: type: string description: FactSet-defined or User-defined Group identifier. nullable: true example: abc123 frequency: type: string description: Grouping frequency nullable: true example: example_value UnlinkedPATemplateSummary: type: object properties: description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title category: type: string description: Unlinked template category nullable: true example: example_value UnlinkedPATemplate: type: object properties: id: type: string description: Template id. nullable: true example: abc123 directory: type: string description: Template directory. nullable: true example: example_value templateTypeId: type: string description: Template type id nullable: true example: '500123' snapshot: type: boolean description: snapshot. example: true accounts: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of accounts nullable: true example: [] benchmarks: type: array items: $ref: '#/components/schemas/PAIdentifier' description: List of benchmarks nullable: true example: [] columns: type: array items: $ref: '#/components/schemas/PACalculationColumn' description: List of columns for the PA calculation nullable: true example: [] dates: $ref: '#/components/schemas/PADateParameters' groups: type: array items: $ref: '#/components/schemas/PACalculationGroup' description: List of groupings for the PA calculation nullable: true example: [] datasources: $ref: '#/components/schemas/PACalculationDataSources' currencyisocode: type: string description: Currency ISO code for calculation. nullable: true example: example_value componentdetail: type: string description: PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. nullable: true example: example_value content: $ref: '#/components/schemas/TemplateContentTypes' description: type: string description: Template description. nullable: true example: A sample description. name: type: string description: Template name. nullable: true example: Example Title category: type: string description: Unlinked template category nullable: true example: example_value UnlinkedPATemplateUpdateParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/UnlinkedPATemplateUpdateParameters' meta: nullable: true example: example_value PACalculationDataSources: type: object properties: portfoliopricingsources: type: array items: $ref: '#/components/schemas/PACalculationPricingSource' description: List of portfilio pricing source for the PA calculation nullable: true example: [] benchmarkpricingsources: type: array items: $ref: '#/components/schemas/PACalculationPricingSource' description: List of benchmark pricing source for the PA calculation nullable: true example: [] useportfoliopricingsourcesforbenchmark: type: boolean description: Use portfolio pricing sources for benchmark nullable: true example: true UnlinkedPATemplateParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/UnlinkedPATemplateParameters' meta: nullable: true example: example_value LinkedPATemplateSummaryRoot: required: - data type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/LinkedPATemplateSummary' example: example_value meta: nullable: true example: example_value LinkedPATemplateParameters: required: - directory - parentComponentId type: object properties: directory: type: string description: The directory to create a linked PA template example: example_value parentComponentId: type: string description: Parent component id example: '500123' description: type: string description: Template description nullable: true example: A sample description. content: $ref: '#/components/schemas/TemplateContentTypes' UnlinkedPATemplateSummaryRoot: required: - data type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/UnlinkedPATemplateSummary' example: example_value meta: nullable: true example: example_value securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation