openapi: 3.0.3 info: title: Factset Analytics Datastore About Templated 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: Templated paths: /analytics/engines/pa/v3/templated-components: post: tags: - Templated summary: Factset Create Templated Pa Component description: "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H.\r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component." operationId: createTemplatedPAComponents requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentParametersRoot' example: data: directory: Personal:TemplatedPAComponents/ parentTemplateId: 01234567890123456789012345678901 description: This is a templated PA component componentData: 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 groups: - id: 5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA frequency: BeginningOfPeriod columns: - id: BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0 statistics: - eb9d6d91416e4224bacadc261787e56f datasources: portfoliopricingsources: - id: 39A1C0C7BD46731552B29D913804EC5F3ED91E6B991AF298DEC88CCA2A9FC6B3 benchmarkpricingsources: - id: 9BB2A3142C450AF54A7486C1D37A210A64474B2499A1E4A30E19801B9FC55E8C useportfoliopricingsourcesforbenchmark: false currencyisocode: USD componentdetail: GROUPS required: true responses: '201': description: Expected response, templated PA component created successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Templated summary: Factset Get Templated Pa Components in Path description: This endpoint returns the list of templated PA components in path. operationId: getTemplatedPAComponentsInPath parameters: - name: directory in: query description: Get templated PA components in path required: true schema: type: string description: Get templated PA components in path example: Personal:TemplatedPAComponents/ responses: '200': description: Expected response, returns a list templated PA components. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pa/v3/templated-components/{id}: put: tags: - Templated summary: Factset Update Templated Pa Component description: "This endpoint allows the user to change the request body from an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings in the POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), \r\n VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. \r\n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\n\r\n* Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'.\r\n Additionally, while 'groupsall' returns all the group levels in the PA component,\r\n setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component.\r\n\r\n* If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding \r\n the default frequency of the Beginning of Period to whatever we pass in the request body.\r\n \r\n* If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component." operationId: updateTemplatedPAComponents parameters: - name: id in: path description: Unique identifier for a templated PA component required: true schema: type: string description: Unique identifier for a templated PA component example: 01234567890123456789012345678901 requestBody: description: Request Parameters content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot' example: data: parentTemplateId: 01234567890123456789012345678901 description: This is a templated PA component componentData: 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 groups: - id: 5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA frequency: BeginningOfPeriod columns: - id: BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0 statistics: - eb9d6d91416e4224bacadc261787e56f datasources: portfoliopricingsources: - id: 39A1C0C7BD46731552B29D913804EC5F3ED91E6B991AF298DEC88CCA2A9FC6B3 benchmarkpricingsources: - id: 9BB2A3142C450AF54A7486C1D37A210A64474B2499A1E4A30E19801B9FC55E8C useportfoliopricingsourcesforbenchmark: false currencyisocode: USD componentdetail: GROUPS required: true responses: '200': description: Expected response, updated successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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 or template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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: - Templated summary: Factset Get Templated Pa Component by Id description: This endpoint fetches the templated PA component settings. operationId: getTemplatedPAComponentById parameters: - name: id in: path description: Unique identifier for a templated PA component required: true schema: type: string description: Unique identifier for a templated PA component example: 01234567890123456789012345678901 responses: '200': description: Expected response, templated PA component details. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplatedPAComponentRoot' '400': description: Invalid data provided. Please check the request parameters before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: Templated PA component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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: - Templated summary: Factset Delete Templated Pa Component description: This endpoint deletes an existing templated PA component operationId: deleteTemplatedPAComponents parameters: - name: id in: path description: Unique identifier for a templated PA component required: true schema: type: string description: Unique identifier for a templated PA component example: 01234567890123456789012345678901 responses: '204': description: Expected response, deleted the templated PA component successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '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 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 TemplatedPAComponentPostSummaryRoot: required: - data type: object properties: data: $ref: '#/components/schemas/TemplatedPAComponentPostSummary' meta: nullable: true example: example_value TemplatedPAComponentParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/TemplatedPAComponentParameters' meta: nullable: true example: example_value TemplatedPAComponentUpdateParametersRoot: required: - data type: object properties: data: $ref: '#/components/schemas/TemplatedPAComponentUpdateParameters' 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' TemplatedPAComponentParameters: required: - directory - parentTemplateId type: object properties: directory: type: string description: Directory to create templated components example: example_value parentTemplateId: type: string description: Parent template id example: '500123' description: type: string description: Component description. nullable: true example: A sample description. componentData: $ref: '#/components/schemas/PAComponentData' 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. 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: [] ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' nullable: true example: [] 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 PAComponentData: type: object properties: 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: [] groups: type: array items: $ref: '#/components/schemas/PACalculationGroup' description: List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. nullable: true example: [] columns: type: array items: $ref: '#/components/schemas/PACalculationColumn' description: List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. nullable: true example: [] dates: $ref: '#/components/schemas/PADateParameters' 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 TemplatedPAComponentUpdateParameters: type: object properties: parentTemplateId: type: string description: Parent template id nullable: true example: '500123' description: type: string description: Component description. nullable: true example: A sample description. componentData: $ref: '#/components/schemas/PAComponentData' ErrorSource: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value TemplatedPAComponentSummary: type: object properties: description: type: string nullable: true example: A sample description. name: type: string nullable: true example: Example Title parentTemplateId: type: string nullable: true example: '500123' type: 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 TemplatedPAComponent: type: object properties: id: type: string nullable: true example: abc123 directory: type: string nullable: true example: example_value snapshot: type: boolean example: true componentData: $ref: '#/components/schemas/PAComponentData' description: type: string nullable: true example: A sample description. name: type: string nullable: true example: Example Title parentTemplateId: type: string nullable: true example: '500123' type: type: string 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 TemplatedPAComponentSummaryRoot: required: - data type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/TemplatedPAComponentSummary' example: example_value meta: nullable: true example: example_value TemplatedPAComponentPostSummary: type: object properties: id: type: string nullable: true example: abc123 description: type: string nullable: true example: A sample description. name: type: string nullable: true example: Example Title parentTemplateId: type: string nullable: true example: '500123' type: type: string nullable: true example: example_value TemplatedPAComponentRoot: required: - data type: object properties: data: $ref: '#/components/schemas/TemplatedPAComponent' 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