openapi: 3.0.3 info: title: Factset Analytics Datastore About Name 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: Name paths: /analytics/pub-datastore/swivel/v1/{document}/{assetName}/{reportId}/{tileId}/{accountId}: get: tags: - Name summary: Factset Redirects to the Underlying Pa/spar Data Represented in a Stach Format, With No as of Date Specified. description: "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getStachMappingNoDate parameters: - name: document in: path description: The Publisher or Analytics Datafeed document containing the report required: true schema: type: string example: Analytics_Datastore - name: assetName in: path description: The PA/SPAR asset name and extension required: true schema: type: string example: ADS_Demo.PA3 - name: reportId in: path description: The PA/SPAR report ID required: true schema: type: string example: report7 - name: tileId in: path description: The PA/SPAR tile ID required: true schema: type: string example: tile0 - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/swivel/v1/{document}/{assetName}/{reportId}/{tileId}/{accountId}/{date}: get: tags: - Name summary: Factset Redirects to the Underlying Pa/spar Data Represented in a Stach Format. description: "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getStachMapping parameters: - name: document in: path description: The Publisher or Analytics Datafeed document containing the report required: true schema: type: string example: Analytics_Datastore - name: assetName in: path description: The PA/SPAR asset name and extension required: true schema: type: string example: ADS_Demo.PA3 - name: reportId in: path description: The PA/SPAR report ID required: true schema: type: string example: report7 - name: tileId in: path description: The PA/SPAR tile ID required: true schema: type: string example: tile0 - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE - name: date in: path description: The as of date for the report required: true schema: type: string format: date example: '2023-01-01' responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/swivel/v1/{document}/{assetName}/{reportId}/{tileId}/{accountId}/{configId}/{date}: get: tags: - Name summary: Factset Redirects to the Underlying Insight/vault Data in a Stach Format. description: "The inclusion of a configId in the path indicates this is for Insight/Vault mappings only, as PA/SPAR mappings do not support the concept of configuration id.\r\n\r\nTakes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getInsightMapping parameters: - name: document in: path description: The Analytics Datafeed document containing the report required: true schema: type: string example: Analytics_Datastore - name: assetName in: path description: The PA/SPAR asset name and extension required: true schema: type: string example: ADS_Demo.PA3 - name: reportId in: path description: The PA/SPAR report ID required: true schema: type: string example: report7 - name: tileId in: path description: The PA/SPAR tile ID required: true schema: type: string example: tile0 - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE - name: configId in: path description: The Vault configuration ID required: true schema: type: string example: acb5150d-4333-49e7-8e33-4f7fa749691e - name: date in: path description: The as of date for the report required: true schema: type: string format: date example: '2023-01-01' responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/tags/{name}: get: tags: - Name summary: Factset Get a Single Tag Definition Based on Its Name description: Retrieve a tag definition based on its name operationId: getSingleTagEndPoint parameters: - name: name in: path description: The name of the tag required: true schema: type: string responses: '200': description: Expected response, returns the tag requested content: application/json: schema: $ref: '#/components/schemas/TagResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/tags/{name}/values: post: tags: - Name summary: Factset Gets a List of Tag Values for the Given Name description: Returns a list of tag values depending on the name provided. Supports filtering on additional tag name value pairs, which operates as an 'AND' where the Document must have the tag name specified in the path AND the filtered parameter. operationId: getTagValuesEndPoint parameters: - name: name in: path description: The name of the tag required: true schema: type: string requestBody: description: Request body to apply when filtering on this end point. Pagination controls are applied through the pagination object and additional tag filters can be used by supplying the tag name and its value in the tags object. required: true content: application/json: schema: $ref: '#/components/schemas/TagFilterModel' responses: '200': description: Expected response, returns a list of tag definitions the user has access to. content: application/json: schema: $ref: '#/components/schemas/TagValuesListResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/media/download/{namespace}/{scope}/{guid}/{fileName}: get: summary: Factset Retrieve a Specific Media File parameters: - name: namespace in: path required: true description: The namespace of the media file schema: example: partners type: string pattern: (partners|products|resources) enum: - partners - products - resources - name: scope in: path required: true description: The scope of the media file schema: example: logo type: string pattern: (logo|avatar|documents) enum: - logo - avatar - documents - name: guid in: path required: true description: The GUID of the file being requested schema: example: 774c3a5c-cc77-4e4c-b4a8-224a35cb00ba type: string - name: fileName in: path required: true description: The name you want to show for this file in the uri. schema: example: FactSet.png type: string responses: '200': description: OK '404': description: Not Found tags: - Name x-microcks-operation: delay: 0 dispatcher: FALLBACK head: summary: Factset Check the existence and retrieve the headers of a spefic media file parameters: - name: namespace in: path required: true description: The namespace of the media file schema: example: partners type: string pattern: (partners|products|resources) enum: - partners - products - resources - name: scope in: path required: true description: The scope of the media file schema: example: logo type: string pattern: (logo|avatar|documents) enum: - logo - avatar - documents - name: guid in: path required: true description: The GUID of the file being requested schema: example: 774c3a5c-cc77-4e4c-b4a8-224a35cb00ba type: string - name: fileName in: path required: true description: The name you want to show for this file in the uri. schema: example: FactSet.png type: string responses: '200': description: OK '404': description: Not Found tags: - Name /analytics/accounts/v3/models/{name}: put: tags: - Name summary: Factset Create or Update an Existing Model Account operationId: createOrUpdateModelAccount parameters: - name: name in: path description: The path and filename of the model account to create or update required: true schema: type: string description: The path and filename of the model account to create or update requestBody: description: The object containing the input values content: application/json: schema: $ref: '#/components/schemas/ModelAccountFieldsRoot' example: data: iterative: '20191010': FDS: weight: '20' price: '50' priceiso: USD GOOGL: weight: '20' price: '50' priceiso: USD nonIterative: GOOGL: taxable: 'false' FDS: taxable: 'false' additionalFields: - iteration: false name: TAXABLE type: STRING description: Taxable splitDirection: NONE size: 0 meta: description: Test desc responses: '200': description: Expected response, updated model account headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '201': description: Expected response, created model account headers: Location: description: Location of the resource created schema: type: string description: Location of the resource created X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '204': description: Model account doesn't exist headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '400': description: Invalid POST body. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string 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: 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' '413': description: Request body too large headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '415': description: Missing/Invalid Content-Type header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header 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: - Name summary: Factset Delete Model Account, Takes an Account Path and Name and Deletes It. operationId: deleteAModelAccount parameters: - name: name in: path description: The path and filename of model account to delete required: true schema: type: string description: The path and filename of model account to delete responses: '204': description: Expected response, no content headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left 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 model account name or type parameter provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Name summary: Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data operationId: getAccount parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 '500': description: Server error. Log the X-DataDirect-Request-Key header 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/accounts/v3/models/{name}/symbols/{symbol}: delete: tags: - Name summary: Factset Delete All Entries for a Symbol or Specific Date Entries for a Symbol From a Previously Created Account. operationId: deleteModelAccountBySymbol parameters: - name: name in: path description: The filename of model account to delete required: true schema: type: string description: The filename of model account to delete - name: symbol in: path description: The symbol from the given file name to delete required: true schema: type: string description: The symbol from the given file name to delete - name: dates in: query description: The dates from the given file name and symbol to delete (Maximum 10 dates are allowed) schema: type: array items: type: string description: The dates from the given file name and symbol to delete (Maximum 10 dates are allowed) responses: '204': description: Expected response, no content headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left 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 model account name or symbol parameter provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '500': description: Server error. Log the X-DataDirect-Request-Key header 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: - Name summary: Factset Get Account Endpoint, Takes an Account Name, Symbol and Returns Underlying Data for That Symbol operationId: getAccountForSymbol parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: symbol in: path description: The symbol for which data needs to be updated required: true schema: type: string description: The symbol for which data needs to be updated - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 '500': description: Server error. Log the X-DataDirect-Request-Key header 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/accounts/v3/models/{name}/dates/{date}: delete: tags: - Name summary: Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account. operationId: deleteModelAccountByDate parameters: - name: name in: path description: The filename of model account to delete required: true schema: type: string description: The filename of model account to delete - name: date in: path description: The date from the given file name to delete required: true schema: type: string description: The date from the given file name to delete - name: symbols in: query description: The symbols from the given file name and date to delete (Maximum 10 symbols are allowed) schema: type: array items: type: string description: The symbols from the given file name and date to delete (Maximum 10 symbols are allowed) responses: '204': description: Expected response, no content headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left 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 model account name or date parameter provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '500': description: Server error. Log the X-DataDirect-Request-Key header 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: - Name summary: Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date operationId: getAccountForDate parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: date in: path description: The date for which data needs to be updated required: true schema: type: string description: The date for which data needs to be updated - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 '500': description: Server error. Log the X-DataDirect-Request-Key header 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/accounts/v3/models/{name}/dates/{date}/symbols/{symbol}: get: tags: - Name summary: Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data operationId: getAccountForDateAndSymbol parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: symbol in: path description: The symbol for which data needs to be updated required: true schema: type: string description: The symbol for which data needs to be updated - name: date in: path description: The date for which data needs to be updated required: true schema: type: string description: The date for which data needs to be updated - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 '500': description: Server error. Log the X-DataDirect-Request-Key header 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/accounts/v3/models/{name}/schema: get: tags: - Name summary: Factset Get Account Schema Endpoint, Takes an Account Name and Returns Its Schema operationId: getAccountSchema parameters: - name: name in: path description: The path and filename of the account to get its schema required: true schema: type: string description: The path and filename of the account to get its schema responses: '200': description: Expected response, returns JSON representation of the account's schema. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: 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: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 '500': description: Server error. Log the X-DataDirect-Request-Key header 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 /jobs/{type}/{name}: parameters: - schema: $ref: '#/components/schemas/jobTypes' name: type in: path required: true description: The jobs type - schema: type: string name: name in: path required: true description: The jobs name get: summary: Factset Get Details for the Given Prb Job tags: - Name responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/jobDetailsResponse' examples: PA: value: data: documents: my_task_1: - Client:/equity/long_short/my PA document my_task_2: - Client:/equity/long_short/my other PA document - Client:/equity/long_only/my PA document tasks: - my_task_1 - my_task_2 accounts: my_task_1: - portfolioId: client:/some_path/some_portfolio.actm isSplit: true includeParent: true level: '1' latestComponentsOnly: true my_task_2: - portfolioId: client:/some_other_path/some__other_portfolio.acct isSplit: true includeParent: true level: all latestComponentsOnly: true runs: - statusDescription: job has completed with success status: created prbStatus: success submitTime: '2019-08-24T14:15:22Z' startTime: '2019-08-24T14:15:22Z' endTime: '2019-08-24T14:15:22Z' runDuration: 0 isApiTriggered: true id: '565642' PD: value: data: documents: default: - Client:/equity/long_short/my document1 runs: - statusDescription: job has completed with success status: created prbStatus: success submitTime: '2019-08-24T14:15:22Z' startTime: '2019-08-24T14:15:22Z' endTime: '2019-08-24T14:15:22Z' runDuration: 1235 isApiTriggered: true id: '3456' PI: value: data: documents: my_task_1: - Client:/equity/long_short/my PA document tasks: - my_task_1 accounts: my_task_1: - portfolioId: client:/some_path/some_portfolio.actm runs: - statusDescription: job has completed with success status: created prbStatus: success submitTime: '2019-08-24T14:15:22Z' startTime: '2019-08-24T14:15:22Z' endTime: '2019-08-24T14:15:22Z' runDuration: 4567 isApiTriggered: true id: '1234' headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' '400': description: Invalid post body parameters. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/clientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' '404': description: Not Found - invalid inputs content: application/json: schema: $ref: '#/components/schemas/clientErrorResponse' headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' 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: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' operationId: getDetailsForJob parameters: - schema: type: array items: enum: - documents - tasks - accounts - runs type: string maxItems: 4 explode: false in: query name: attribute description: The attribute parameter accepts a list of the given enums, separated by commas. Each of them returns the respective data associated with the job. Runs returns the run history of the job. description: Use this endpoint to fetch the documents, tasks, accounts, and/or runs for the PRB job given in the path. Please note jobs with type PD will not return tasks nor accounts so this will be ignored if given as part of the array of attributes in the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /news/publisher/searchByName: post: tags: - Name operationId: post/news/publisher/searchByName x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false summary: Factset Search for Publishers. description: Search for publishers by the name of the publisher. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNewsPublisherSearchByNameRequest' required: true responses: '200': $ref: '#/components/responses/PostNewsPublisherSearchByName200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/timezone/getByName: get: tags: - Name operationId: get/basic/timezone/getByName x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Details of a timezone identified by name, as specified by the Internet Assigned Numbers Authority. See http://www.iana.org/time-zones for further details. Not all such timezones are available on the MDG. summary: Factset Details of a Timezone Identified by Name. parameters: - name: name in: query schema: type: string pattern: ^[A-Za-z_/-]+$ minLength: 1 exclusiveMinimum: false maxLength: 100 exclusiveMaximum: false description: Name of a timezone. The result is determined by a case-sensitive equality comparison with the stored timezone names. An invalid or unsupported name will result in an error. required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetBasicTimezoneGetByName200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/{tenant}/report-instances/{reportInstanceId}/results/{reportFileName}: get: operationId: getReportFile tags: - Name summary: Factset Gets the Generated File description: Get the generated file for a report instance. Users can fetch the generated report once the genration is finished. The report instance id and the report file name are passed in as path paramters parameters: - in: path name: tenant description: The code of the tenancy schema: type: string required: true - in: path name: reportInstanceId description: Used to validate that report file name belongs to the report instance passed schema: type: string required: true - in: path name: reportFileName description: 'The report file name that has to be retrieved. report file name. E.g: xyz.pdf' schema: type: string required: true responses: '200': description: Successful operation '400': description: The supplied report instance id was either missing or invalid or the report instance was not found. The supplied report file name was either invalid or not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: errors: - id: ID of the error code: parameterError title: The ID passed is not a numerical value '401': description: Unauthorised content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: errors: - id: ID of the error code: notAuthenticated title: User is not authenticated '403': description: No permissions to view the generated file in VRS content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: errors: - id: ID of the error code: notAuthorized title: No permissions to view this item '406': description: Unsupported Accept header. Header needs to be set to application/json. content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: errors: - id: ID of the error code: notAcceptable title: "Unsupported Accept header. Header needs to be set to\n application/json" x-microcks-operation: delay: 0 dispatcher: FALLBACK /portfolio/name/list: get: tags: - Name operationId: get/portfolio/name/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: true x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 2 x-supportsPermissionDeniedResponse: false description: List of portfolios. summary: List of portfolios. responses: '200': $ref: '#/components/responses/GetPortfolioNameList200Response' parameters: - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed. schema: type: array items: type: string enum: - id - -id - name - -name maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query components: schemas: clientErrorResponse: description: The response schema for reporting errors properties: errors: description: List of errors items: $ref: '#/components/schemas/error' type: array example: [] type: object TagResponse: type: object description: Response object for a single tag properties: data: $ref: '#/components/schemas/TagModel' error: description: Full details of any error properties: code: description: The error code type: string example: example_value detail: description: Explanation specific to the occurrence of the error type: string example: example_value id: description: Identifier for the error type: string example: abc123 source: $ref: '#/components/schemas/errorSource' title: description: The title of the error type: string example: Example Title type: object TagModel: type: object properties: name: type: string description: The name of the tag example: account type: type: string description: The type of the tag example: string enum: - string - date - datetime description: Tags model MetaRequestModel: type: object description: Meta request model which includes pagination controls properties: pagination: type: object properties: offset: type: integer example: 0 limit: type: integer example: 10 example: example_value accountsForJobAddProp: description: The details of the account under the task in the object key properties: includeParent: description: Indicates whether or not the parent portfolio is included as a separate portfolio when isSplit is true nullable: true type: boolean example: true isSplit: description: Indicates whether the portfolio's components if any would be treated as individual portfolios when the job is run nullable: true type: boolean example: true latestComponentsOnly: description: When selected, the ACTM/CSTM will be split and will only return components that are still held in the ACTM. I.e., when the end date is "Latest," it will not return components where the end date occurs before Latest. nullable: true type: boolean example: true level: description: The number of levels when isSplit is true that the job will expand down to for a composite portfolio (CSTM or ACTM). "1" means only the first level will be expanded. "all" will be the value if all levels are expanded down. nullable: true type: string example: example_value portfolioId: description: The full file path including portfolio name and type type: string example: '500123' type: object StatusObject_2: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). description: The status member contains the status code of the response. required: - code documentsForJob: additionalProperties: description: The tasks under each document items: type: string type: array description: Shows the documents for each job where relevant with a collection of tasks under each document example: my_task_1: - Client:/equity/long_short/my PA document my_task_2: - Client:/equity/long_only/my PA document - Client:/equity/long_short/my other PA document title: documentsForJob type: object Error_2: type: object properties: id: type: string example: abc123 code: type: string example: example_value title: type: string example: Example Title AttributesMember: type: array description: Limit the attributes returned in the response to the specified set. items: type: string maxLength: 100 exclusiveMaximum: false maxItems: 50 uniqueItems: true errorSource: description: The pointer and parameter of the error properties: parameter: description: Indicates which path or URI query parameter caused the error type: string example: example_value pointer: description: Pointer to the associated entity in the request body type: string example: example_value type: object prbStatus: description: The status of the job as per the application enum: - failed - pending - running - soft - stopped - success - warning example: running title: prbStatus type: string Error: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' StatusObject: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). example: 42.5 description: The status member contains the status code of the response. required: - code status: description: The status of the job as per FactSets API standards enum: - cancelled - created - executing - failed - queued example: queued title: status type: string PostNewsPublisherSearchByNameRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - searchValue - matchType - filter description: The data member contains the request's primary data. properties: searchValue: type: string minLength: 2 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: true description: Restricts the search to publishers, which match the search value. The comparison for a match is case sensitive. matchType: type: string description: The match type that is applied to the search. x-enum-description: - Publisher name must begin with the searchValue. - Publisher name must end with the searchValue. - Publisher name must begin, end, or contain the searchValue. enum: - begins - ends - contains filter: description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. type: object x-property-sort: - distributor - delivery properties: distributor: type: object x-property-sort: - id description: Filter for distributors. See endpoint `/news/distributor/list` for valid values. properties: id: type: number format: id32 x-positive: true description: Identifier of distributor. delivery: type: object x-property-sort: - id description: Filter for deliveries. See endpoint `/basic/delivery/list` for valid values. properties: id: type: number format: id32 x-positive: true description: Identifier of delivery. required: - searchValue - matchType example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - id - -id - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - sort example: example_value ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: [] accountsForJob: additionalProperties: description: An array of the details of the account/s under the task/s in the object key/s items: $ref: '#/components/schemas/accountsForJobAddProp' type: array description: Please note for PI jobs you will only see portfolioId example: my_task_1: - includeParent: true isSplit: true latestComponentsOnly: true level: string portfolioId: string title: accountsForJob type: object ErrorSource: type: object properties: pointer: type: string example: example_value parameter: type: string example: example_value MetaModel: type: object description: Meta model which includes pagination information properties: pagination: type: object properties: total: type: integer description: Total number of entries in the result set example: 1 isEstimatedTotal: type: boolean description: Flag indicating that the value of total is estimated example: false description: Pagination attributes for the offset-based pagination strategy example: example_value tasksForJob: description: A list of tasks for the given job example: - my_task_1 items: example: my_task_1 type: string title: tasksForJob type: array maxItems: 200 TagValuesListResponse: type: object description: Response object for a list of tag values properties: meta: $ref: '#/components/schemas/MetaModel' data: type: array items: type: string description: Array of tag values example: - TEST_ACCOUNT.ACCT - CLIENT.ACCT statusDescription: description: Further details on the job's status example: job has completed with success title: statusDescription type: string maxLength: 500 TagFilterModel: type: object description: Request object for requesting product types properties: meta: $ref: '#/components/schemas/MetaRequestModel' data: type: object properties: tags: type: object description: The documents tags, represented in a key value format with the tag name as the key; and the tag's value as the value example: account: TEST_ACCOUNT.ACCT benchmark: TEST_BENCHMARK additionalProperties: type: string example: example_value runsForJob: description: Provides full details of when the job has been run example: endTime: '2019-08-24T14:15:22Z' id: '2365478' isApiTriggered: true prbStatus: success runDuration: 6000 startTime: '2019-08-24T14:15:22Z' status: created statusDescription: job has completed with success submitTime: '2019-08-24T14:15:22Z' properties: endTime: description: The date and time the job was finished processing format: date-time type: string example: '2026-01-15T10:30:00Z' id: description: The ID of the run type: string example: abc123 isApiTriggered: description: Indicates whether the job was triggered via the PRB API type: boolean example: true prbStatus: $ref: '#/components/schemas/prbStatus' runDuration: description: Number of seconds between startTime and endTime type: number example: 42.5 startTime: description: The date and time the job started running after being submitted and potentially waiting in any queue format: date-time type: string example: '2026-01-15T10:30:00Z' status: $ref: '#/components/schemas/status' statusDescription: $ref: '#/components/schemas/statusDescription' submitTime: description: The date and time the job was submitted format: date-time type: string example: '2026-01-15T10:30:00Z' title: runsForJob type: object jobDetailsResponse: description: Provides the requested details for the specified job and if no attributes are provided, full details will be given properties: data: description: The main object in the jobDetailsResponse schema properties: accounts: $ref: '#/components/schemas/accountsForJob' documents: $ref: '#/components/schemas/documentsForJob' runs: description: An array of information for each run items: $ref: '#/components/schemas/runsForJob' type: array tasks: $ref: '#/components/schemas/tasksForJob' type: object example: example_value title: jobDetailsResponse type: object ErrorList: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_2' example: [] ModelAccountFieldsRoot: required: - data type: object properties: data: $ref: '#/components/schemas/ModelAccountFields' meta: type: object additionalProperties: type: string example: example_value jobTypes: description: PA - Portfolio Analysis, PUB - Publisher, ADF - Analytics DataFeed, PI - Portfolio Insight, PD - Portfolio Dashboard, Portfolio Vault - vault enum: - ADF - PA - PD - PI - PUB - vault example: vault title: jobTypes type: string ModelAccountAdditionalField: type: object properties: iteration: type: boolean example: true name: type: string example: Example Title type: type: string example: example_value description: type: string example: A sample description. splitDirection: type: string example: example_value size: type: integer format: int32 example: 10 codePageFlag: type: string example: example_value ModelAccountFields: required: - iterative type: object properties: iterative: type: object additionalProperties: type: object additionalProperties: type: object additionalProperties: type: string example: example_value nonIterative: type: object additionalProperties: type: object additionalProperties: type: string example: example_value additionalFields: type: array items: $ref: '#/components/schemas/ModelAccountAdditionalField' example: [] DataAndMetaModel: required: - data type: object properties: data: example: example_value meta: example: example_value headers: X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. responses: GetBasicTimezoneGetByName200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a timezone. name: nullable: true type: string description: Name according to the Internet Assigned Numbers Authority. description: Details of a timezone. nullable: false x-property-sort: - id - name meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostNewsPublisherSearchByName200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of publishers. nullable: false items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true x-sortable: true type: number format: id32 x-positive: true description: Identifier of the publisher. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: Name of the publisher. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetPortfolioNameList200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of portfolios. nullable: false type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true description: Identifier of the portfolio. x-sortable: true type: string format: id64 x-positive: true name: nullable: true description: Name of the portfolio. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject_2' x-property-sort: - status securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation