🎉 Flexmonster Pivot Table & Charts v2.8 has arrived!Read the blog post
Get Free Trial
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Cell Data Object
    11. Chart Data Object
    12. Toolbar Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeAPIRequest
    13. customizeCell
    14. customizeContextMenu
    15. dispose
    16. expandAllData
    17. expandData
    18. exportTo
    19. getAllConditions
    20. getAllHierarchies
    21. getAllMeasures
    22. getCell
    23. getColumns
    24. getCondition
    25. getFilter
    26. getFormat
    27. getMeasures
    28. getMembers
    29. getOptions
    30. getReport
    31. getReportFilters
    32. getRows
    33. getSelectedCell
    34. getSort
    35. getXMLACatalogs
    36. getXMLACubes
    37. getXMLADataSources
    38. getXMLAProviderName
    39. load
    40. off
    41. on
    42. open
    43. openCalculatedValueEditor
    44. openFieldsList
    45. openFilter
    46. print
    47. refresh
    48. removeAllCalculatedMeasures
    49. removeAllConditions
    50. removeCalculatedMeasure
    51. removeCondition
    52. removeSelection
    53. runQuery
    54. save
    55. setFilter
    56. setFormat
    57. setOptions
    58. setReport
    59. setSort
    60. showCharts
    61. showGrid
    62. showGridAndCharts
    63. sortingMethod
    64. sortValues
    65. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. update
  5. Custom API requests
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for pivot table
    6. /select request for flat table
    7. /select request for drill-through view
    8. Field Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
Table of contents

/fields request

[starting from version: 2.8]

A request for all fields with their types (i.e., meta-object or schema).

Request

{
"type": "fields"
"index": string
}

Response

{
    "fields"[]: {
        "uniqueName": string,
        "type": "string" | "number" | "date",
        "caption": string,
        "folder": string,
        "interval": string,
        "aggregations": string[],
        "filters": boolean | {
            "members": boolean,
            "query": boolean | string[],
            "valueQuery": boolean | string[]
        }
    },
    "aggregations": string[] | {
        "any": string[],
        "date": string[],
        "number": string[],
        "string": string[]
    },
    "filters": boolean | {
        "any": boolean | {
            "members": boolean,
            "query": boolean | string[],
            "valueQuery": boolean | string[]
        },
        "date": boolean | {
            "members": boolean,
            "query": boolean | string[],
            "valueQuery": boolean | string[]
        },
        "number": boolean | {
            "members": boolean,
            "query": boolean | string[],
            "valueQuery": boolean | string[]
        },
        "string": boolean | {
            "members": boolean,
            "query": boolean | string[],
            "valueQuery": boolean | string[]
        }
    },
    "sorted": boolean
}

Response has the following parameters:

  • fields – Array of field objects. Contains the following informaion about strings:
    • uniqueName – String. Field’s unique name that is used in the requests.
    • type – String. Field’s type. Supported values are: "string", "number", "date".
    • caption (optional) – String. Field’s caption that appears on the UI.
    • folder (optional) – String. Field’s folder that is used to organize groups of fields in the Field List. Supports nesting via /(e.g. "Folder/Subfolder").
    • interval (optional) – String. A date’s aggregation interval. If the field’s type is "date", this field can have an interval property defined in the schema that will be included in requests and can be used by the server to group dates.
    • aggregations (optional) – Array of strings. Array of supported aggregation functions for the field. Supported values include: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "stdevp", "stdevs", "none".
    • filters (optional) – Boolean|Object. Supported filters for the field. The filters are turned off by default if they are not defined in the root of the schema. The supported filters can be defined for each field individually. They can be enabled all at once by setting this property to true, or each filter type can be turned on separately.
      • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled for the field in Flexmonster.
      • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on labels. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the labels filter.
        Supported conditions depend on the field type.
        For the "string" type they are: "equal", "not_equal", "begin", "not_begin", "end", "not_end", "contain", "not_contain", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
        For the "number" type they are: "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
        For the "date" type they are: "equal", "not_equal", "before", "before_equal", "after", "after_equal", "between", "not_between", "last", "current", "next".
      • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter.
        Supported conditions: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
  • aggregations (optional) – Array of strings|Object. Supported aggregation functions.
    They can be defined for all fields, for fields of a certain type, and for each field individually. Supported values include: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "stdevp", "stdevs", "none".
    • any (optional) – Array of strings|Object. Supported aggregation functions for any field type.
    • date (optional) – Array of strings|Object. Supported aggregation functions for the "date" field type.
    • number (optional) – Array of strings|Object. Supported aggregation functions for the "number" field type.
    • string (optional) – Array of strings|Object. Supported aggregation functions for the "string" field type.
  • filters (optional) – Boolean|Object. Supported filters.
    They can be defined for all fields, for fields of a certain type, and for each field individually. The filters are turned off by default. They can be turned on all at once by setting this property to true, or each filter type can be configured separately for fields of a certain type.
    • any (optional) – Boolean|Object. Supported filters for any field type.
      • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled in Flexmonster.
      • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on labels. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the labels filter.
        Supported conditions depend on the field type. There are 4 common conditions for all field types that can be specified here: "equal", "not_equal", "between", "not_between".
      • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter.
        Supported conditions: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
    • date (optional) – Boolean|Object. Supported filters for the "date" field type.
      • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled in Flexmonster.
      • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on labels. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the labels filter.
        Supported conditions depend on the field type. For the “date” type they include: "equal", "not_equal", "before", "before_equal", "after", "after_equal", "between", "not_between", "last", "current", "next".
      • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter.
        Supported conditions: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
    • number (optional) – Boolean|Object. Supported filters for the "number" field type.
      • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled in Flexmonster.
      • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on labels. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the labels filter.
        Supported conditions depend on the field type. For the “number” type they include: "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
      • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter.
        Supported conditions: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
    • string (optional) – Boolean|Object. Supported filters for the "string" field type.
      • members (optional) – Boolean. A configuration of an include/exclude members filter. If true, the members filter is enabled in Flexmonster.
      • query (optional) – Boolean|Array of strings. A configuration of a conditional filter on labels. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the labels filter.
        Supported conditions depend on the field type. For the “string” type they include: "equal", "not_equal", "begin", "not_begin", "end", "not_end", "contain", "not_contain", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
      • valueQuery (optional) – Boolean|Array of strings. A configuration of a conditional filter on values. This filter can be turned on by setting the property either to true or by specifying an array of supported conditions. If the property is set to true, this enables all the conditions that exist in Flexmonster for the values filter.
        Supported conditions: "top", "bottom", "equal", "not_equal", "greater", "greater_equal", "less", "less_equal", "between", "not_between".
  • sorted (optional) – Boolean. If true, the fields will be displayed in the same order in the Field List.

See also

/handshake request
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view