/filters/{id}/dimensions/{name}/options

GET

Get a list of all options which will be used to filter the dimension

Responses

200: A list of all options for a dimension was returned

Example value
{
  "description": "A list of options for the dimension",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "description": "A list of links related to this resource",
        "type": "object",
        "properties": {
          "links": {
            "description": "A dimension option",
            "type": "object",
            "properties": {
              "dimension": {
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to the selected dimension this option applies to for the filter",
                    "type": "string",
                    "example": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate"
                  },
                  "id": {
                    "description": "The ID of the dimension for the filter",
                    "type": "string",
                    "example": "aggregate"
                  }
                }
              },
              "filter": {
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to the filter",
                    "type": "string",
                    "example": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324"
                  },
                  "id": {
                    "description": "The ID of the filter",
                    "type": "string",
                    "example": "bd67930a-2856-44b3-a87a-e9e5fb832324"
                  }
                }
              },
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to the options for this filter",
                    "type": "string",
                    "example": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate/options/cpih1dim1T10000"
                  },
                  "id": {
                    "description": "The ID of the option",
                    "type": "string",
                    "example": "cpih1dim1T10000"
                  }
                }
              }
            },
            "readOnly": true
          },
          "option": {
            "description": "The option added to the dimension for this filter",
            "type": "string",
            "example": "cpih1dim1T10000"
          }
        },
        "readOnly": true
      }
    },
    "limit": {
      "description": "The number of options requested",
      "type": "integer"
    },
    "offset": {
      "description": "The first row of options to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter",
      "type": "integer"
    },
    "total_count": {
      "description": "The total number of options",
      "type": "integer",
      "readOnly": true
    }
  },
  "readOnly": true
}

400: Filter was not found

Example value
null

404: Dimension name was not found

Example value
null

500: Failed to process the request due to an internal error

Example value
null