/filters/{id}/submit

POST

Parameters

Name Type Description
id path The unique filter ID for customising a dataset

Responses

202: Query was submitted successfully

Example value
{
  "properties": {
    "dataset": {
      "description": "A version of an edition for a dataset to filter on.",
      "type": "object",
      "properties": {
        "edition": {
          "description": "An edition of a dataset",
          "type": "string"
        },
        "id": {
          "description": "The unique identifier of a dataset",
          "type": "string"
        },
        "version": {
          "description": "A version of a dataset",
          "type": "integer"
        }
      }
    },
    "filter_id": {
      "type": "string"
    },
    "instance_id": {
      "type": "string"
    },
    "links": {
      "description": "A list of links related to this resource",
      "type": "object",
      "properties": {
        "dimensions": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the dimensions list",
              "type": "string",
              "example": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/dimensions"
            }
          }
        },
        "self": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the filter",
              "type": "string",
              "example": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
            },
            "id": {
              "description": "An ID of the version being filtered",
              "type": "string",
              "example": "DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
            }
          }
        },
        "version": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the version being filtered",
              "type": "string",
              "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1"
            },
            "id": {
              "description": "An ID of the version being filtered",
              "type": "string",
              "example": 1
            }
          }
        }
      },
      "readOnly": true
    },
    "population_type": {
      "type": "string"
    }
  }
}

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

Example value
null