Factset · Schema

time_series_result_object_nonflattened_base

An object returning the results for a single identifier and formula. This is the base of the response object. The result attribute depends on the formula requested. Response objects with the various result attribute types are outlined in separate schemas.

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name	Type	Description
error	integer	Indicates that there was an error in the execution of the FQL Formula. * Zero success * Non-zero failure
errorMessage	string	If error is non-zero, errorMessage will display the FQL formula error.
formula	string	FQL formula requested.
displayName	string	Display Name.
requestId	string	Identifier requested.
fsymId	string	The fsymId field returned is the FactSet Default Permanent Identifier for the `requestId`. For all supported `requestId` symbol types, the `fsymId` parameter will return the Regional Level PermId
dataType	string	Type of data returned in `result`
objectType	string	Type of object returned in `result`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "time_series_result_object_nonflattened_base",
  "type": "object",
  "description": "An object returning the results for a single identifier and formula. This is the base of the response object. The result attribute depends on the formula requested. Response objects with the various result attribute types are outlined in separate schemas.",
  "properties": {
    "error": {
      "type": "integer",
      "description": "Indicates that there was an error in the execution of the FQL Formula.\n* Zero  success\n* Non-zero  failure\n"
    },
    "errorMessage": {
      "type": "string",
      "description": "If error is non-zero, errorMessage will display the FQL formula error."
    },
    "formula": {
      "type": "string",
      "description": "FQL formula requested."
    },
    "displayName": {
      "type": "string",
      "description": "Display Name."
    },
    "requestId": {
      "type": "string",
      "description": "Identifier requested."
    },
    "fsymId": {
      "type": "string",
      "description": "The **fsymId** field returned is the FactSet Default Permanent Identifier for the `requestId`. For all supported `requestId` symbol types, the `fsymId` parameter will return the Regional Level PermId '-R' which identifies the securitys best regional security data series per currency. Currently, the fsymId parameter only supports equities. Accepted `requestId` symbol types include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. Further documentation can be found at this [Online Assistant attachment](https://oa.apps.factset.com/cms/oaAttachment/64c3213a-f415-4c27-a336-92c73a72deed/24881). Included only if the `fsymId` parameter is set to Y.\n"
    },
    "dataType": {
      "type": "string",
      "description": "Type of data returned in `result`"
    },
    "objectType": {
      "type": "string",
      "description": "Type of object returned in `result`"
    }
  }
}