time_series_result_object_flattened

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "time_series_result_object_flattened",
  "type": "object",
  "description": "\nData model returned when the parameter **flatten=Y** is used in the request. This flattened, simplified JSON output returned from **flatten=Y** can be conceptualized as a table (rows and columns) where each data object in the result is a row in the table and each field names is a column name. The response will contain at least one data object for each requestId containing the requestId, fsymId (if requested), date (if applicable) and Key-Value pairs for each data item (formula). The number of data objects (rows) per requestId is dependent the the objectTypes of the formulas requested.\n\n\n\nFormulas that have associated dates (TIMESERIES objectType in the standard **flatten=N** response model) will result in a data object for each date for each requestId.\n\n**flatten=N TIMESERIES Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName1\",\n    \"result\": {\n        \"values\": [a,b],\n        \"dates\": [DATE1,DATE2]\n      },\n    \"objectType\": \"TIMESERIES\",\n    \"dataType\": \"DOUBLE\"\n  },\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName2\",\n    \"result\": {\n        \"values\": [c,d],\n        \"dates\": [DATE2,DATE3]\n      },\n    \"objectType\": \"TIMESERIES\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y TIMESERIES Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": a,\n    \"formulaName2\": null,\n    \"date\": DATE1\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": b,\n    \"formulaName2\": c,\n    \"date\": DATE2\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName1\": null,\n    \"formulaName2\": d,\n    \"date\": DATE3\n  }\n]\n```\n\n\n\nFormulas that result in an array (no associated dates, ARRAY objectType in the standard **flatten=N** response model) can be thought of as a column in a table. Each element in the array will be in a separate data object. The first element of the array starts in the first data object for that requestId and then then the second element of the array in the second data object for that requestId and so on (regardless of dates from other formulas).\n\n**flatten=N ARRAY Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName\",\n    \"result\": [a,b,c],\n    \"objectType\": \"ARRAY\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y ARRAY Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": a,\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": b,\n  },\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": c,\n  }\n]\n```\n\n\nScalar data items (SCALAR objectType in the standard **flatten=N** response model) will be repeated in each data object for the requestId.\n\n**flatten=N SCALAR Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formula\": \"formulaName\",\n    \"result\": a,\n    \"objectType\": \"ARRAY\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y SCALAR Representation**\n```json\n[\n  {\n    \"requestId\": \"id\",\n    \"formulaName\": a,\n  }\n]\n```\n\n\nFormulas that result in a matrix (2 dimensional array, MATRIX objectType in the standard **flatten=N** response model) can be thought of as returning a table where each array in the array of arrays is a row in the table. This can be extended to the flattened result structure where each data object is a row in a table.  The formula will have as many attributes (appended by [n]) as number of columns in the matrix result.\n\n**flatten=N MATRIX Representation**\n```json\n[\n  {\n    \"requestId\": \"id\"\n    \"formula\": \"formulaName\",\n    \"result\": [\n        [a,b,c],\n        [d,e,f]\n      ],\n    \"objectType\": \"MATRIX\",\n    \"dataType\": \"DOUBLE\"\n  }\n]\n```\n\n**flatten=Y MATRIX Representation**\n```json\n[\n  {\n    \"requestId\": \"id\"\n    \"formulaName[0]\": a,\n    \"formulaName[1]\": b,\n    \"formulaName[2]\": c\n  },\n  {\n    \"requestId\": \"id\"\n    \"formulaName[0]\": d,\n    \"formulaName[1]\": e,\n    \"formulaName[2]\": f\n  }\n]\n```\n",
  "properties": {
    "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"
    },
    "date": {
      "type": "string",
      "description": "Date associated with FQL formula."
    }
  }
}