Need a special offer?Find out if your project fits.
+
API reference
  • API Reference for older versions
  • Table of contents

    /members request

    [starting from version: 2.8]

    A request for all members of the field.

    Request

    {
      "type": string,
      "index": string,
      "field": FieldObject,
      "filter": FilterObject | FilterGroupObject,
      "page": number
    }
    Property/Type Description
    type
    String
    The type of the request. In this case, it is "members".
    index
    String
    The dataset identifier.
    field
    FieldObject
    The field whose members should be sent in the response.
    filter
    FilterObject | FilterGroupObject
    Filters that should be applied to members. filter is present in the request when multilevel hierarchies are configured in Flexmonster Pivot.
    The filter can be:
    page
    Number
    The page number. It can be used to load members by parts. If the response contains the pageTotal parameter, additional requests will be performed to load the remaining pages. Starts from 0.

    Response

    {
      "members": MemberInfoObject[],
      "sorted": boolean,
      "page": number,
      "pageTotal": number
    }
    Property/Type Description
    members
    MemberInfoObject[]
    Contains the field's members.
    sorted
    Boolean
    optional If true, the members' order from the response will be used as AZ order on the UI.
    page
    Number
    optional The current page number. Starts from 0.
    pageTotal
    Number
    optional The total number of pages. It can be used to load members by parts.

    Examples

    1. Example with a string field
      Request:
      {
          "index": "data-set-123",
          "type": "members",
          "field": {
             "uniqueName": "city"
          },
          "page": 0
      }
      Response:
      {
          "members": [
              { "value": "Toronto" }, 
              { "value": "Montreal" }, 
              { "value": "New York" }
          ]
      }
    2. Example with a number field
      Request:
      {
          "index": "data-set-123",
          "type": "members",
          "field": {
             "uniqueName": "price"
          },
          "page": 0
      }
      Response:
      {
          "members": [
              { "value": 10 }, 
              { "value": 28 }, 
              { "value": 30 }
          ]
      }
    3. Example with a date field
      Request:
      {
          "index": "data-set-123",
          "type": "members",
          "field": {
             "uniqueName": "order_date"
          },
          "page": 0
      }
      Response:
      {
          "members": [
              { "value": 1562889600000 }, 
              { "value": 1564617600000 }, 
              { "value": 1564963200000 }
          ]
      }

    See also

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