Factset · Schema

include_exclude_object

Filters securities based on asset classes and other fields depending on the asset classes.

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name	Type	Description
field	string	String containing the field name to filter on. Each asset class has its own set of field (i.e. equity_type, is_primary, region,etc)
entity	string	String containing the asset class for the filter to be applied on. If not included or left empty, it will apply the filter against all asset classes
values	array	Values you wish to filter on, as a comma-separated list. The values within this list are tied by an OR operation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "include_exclude_object",
  "type": "object",
  "description": "Filters securities based on asset classes and other fields depending on the asset classes.\n",
  "properties": {
    "field": {
      "type": "string",
      "description": "String containing the field name to filter on. Each asset class has its own set of field (i.e. equity_type, is_primary, region,etc)\n"
    },
    "entity": {
      "type": "string",
      "description": "String containing the asset class for the filter to be applied on. If not included or left empty, it will apply the filter against all asset classes\n"
    },
    "values": {
      "type": "array",
      "description": "Values you wish to filter on, as a comma-separated list. The values within this list are tied by an OR operation.\n"
    }
  }
}