/fields request | Flexmonster

1./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
}

The request has the following parameters:

type — String. The type of the request. In this case, it is "fields".
index – String. The dataset identifier.

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[]
        },
        "advanced": boolean
    },
    "sorted": boolean
}

The response has the following parameters:

fields – Array of field objects. Contains the following information 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", "stdevp", "stdevs", "none". Note: for the fields of the "number" type, Flexmonster Pivot supports built-in front-end aggregations.
- 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 members. 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 members filter. See the list of supported conditions for “string”, “number”, and “date” field types.
  - 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. See the list of supported conditions.
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","stdevp", "stdevs", "none". Note: for the fields of the "number" type, Flexmonster Pivot supports built-in front-end aggregations.
To define supported aggregations for certain field types, specify the "aggregations" property as an object with the following properties:
- any (optional) – Array of strings. Supported aggregation functions for any field type.
- date (optional) – Array of strings. Supported aggregation functions for the "date" field type.
- number (optional) – Array of strings. Supported aggregation functions for the "number" field type. Note: for the fields of this type, Flexmonster Pivot supports built-in front-end aggregations.
- string (optional) – Array of strings. 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 members. 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 members filter. 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. See the list of supported conditions.
- 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 members. 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 members filter. See the list of supported conditions for the “date” field type.
  - 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. See the list of supported conditions.
- 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 members. 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 members filter. See the list of supported conditions for the “number” field type.
  - 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. See the list of supported conditions.
- 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 members. 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 members filter. See the list of supported conditions for the “string” field type.
  - 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. See the list of supported conditions.
- advanced – Boolean. Indicates whether the server has advanced hierarchical filters implemented. When the advanced parameter is set to true, it means that the server supports hierarchies and can filter them, so multilevel hierarchies can be configured in the component. When the parameter is false, the server cannot filter the hierarchical data. In this case, if multilevel hierarchies were configured in the Mapping Object, these configurations will be ignored. Default value: false.
sorted (optional) – Boolean. If true, the fields will be displayed in the same order in the Field List.