[starting from version: 2.8]
A request for all fields with their types (i.e., meta-object or schema).
{
"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.{
"fields"[]: {
"uniqueName": string,
"type": "string" | "number" | "date",
"caption": string,
"hierarchy": string,
"parent": 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 objects. Contains the following information about fields: uniqueName
– String. The field’s unique name. Will later be used in /members and /select requests.type
– String. The field’s type. Supported values are: "string"
, "number"
, "date"
.caption
optional – String. The field’s caption to appear on the UI.hierarchy
optional – String. The hierarchy’s name. Used to configure multilevel hierarchies. Specify this property to set the field as a level of a hierarchy.parent
optional – String. The parent level’s unique name. This property is necessary to specify if the field is a level of a hierarchy and has a parent level.folder
optional – String. The field’s folder. Folders are used to organize groups of fields in the Field List. folder
supports nesting via /
(e.g., "Folder/Subfolder"
). interval
optional – String. A date’s aggregation interval to group dates on the server. The component will automatically send it in /members and /select requests. Possible values depend on how the server handles date intervals. Only for fields of the "date"
type.aggregations
optional – Array of strings. A list of supported aggregation functions for the field. To define supported aggregations for all fields, use the root aggregations property."sum"
, "count"
, "distinctcount"
, "average"
, "median"
, "product"
, "min"
, "max"
, "stdevp"
, "stdevs"
, "none"
, or a custom aggregation. 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. To define supported filters for all fields, specify the root filters property.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. To turn on this filter, either set query
to true
or specify an array of supported conditions.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. To turn on this filter, either set valueQuery
to true
or specify an array of supported conditions.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 for all fields or fields of a certain type. Supported aggregations for a certain field can be defined in the fields.aggregations property.aggregations
as an array of strings. Supported values include: "sum"
, "count"
, "distinctcount"
, "average"
, "median"
, "product"
, "min"
, "max"
,"stdevp"
, "stdevs"
, "none"
, or a custom aggregation. Note: for the fields of the "number"
type, Flexmonster Pivot supports built-in front-end aggregations.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 for all fields or for fields of a certain type. To define filters for a specific field, use the fields.filters property.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. To turn on this filter, either set query
to true
or specify an array of supported conditions.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. To turn on this filter, either set valueQuery
to true
or specify an array of supported conditions.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. To turn on this filter, either set query
to true
or specify an array of supported conditions.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. To turn on this filter, either set valueQuery
to true
or specify an array of supported conditions.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. To turn on this filter, either set query
to true
or specify an array of supported conditions.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. To turn on this filter, either set valueQuery
to true
or specify an array of supported conditions.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. To turn on this filter, either set query
to true
or specify an array of supported conditions.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. To turn on this filter, either set valueQuery
to true
or specify an array of supported conditions.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 MappingObject, these configurations will be ignored. Default value: false
. sorted
optional – Boolean. If true
, the fields’ order from the response will be used to display fields in the Field List./handshake request
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view