/filter-outputs/{filter_output_id}
GET
Get document describing the filter output
Responses
200: The filter output was found and document is returned
Example value
{
"description": "A model for the response body when retrieving a filter output",
"allOf": [
{
"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"
}
}
},
"dimensions": {
"type": "array",
"items": {
"description": "A dimension to filter on a dataset. Information on a dimension can be gathered using the `Dataset API`",
"type": "object",
"properties": {
"filter_by_parent": {
"description": "Indicates the dependent variable, one level up, that the dimension should be filtered by",
"type": "string"
},
"is_area_type": {
"description": "Indicates if the dimension is an area type",
"type": "boolean"
},
"name": {
"description": "The name of the dimension to filter on",
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"disclosure_control": {
"type": "object",
"properties": {
"blockedoptions": {
"type": "object",
"properties": {
"blocked_count": {
"description": "The count of blocked options",
"type": "integer"
},
"blocked_options": {
"description": "A list of blocked options applicable to the dimension",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"dimension": {
"description": "The name of the dimension that triggers the disclosure rules",
"type": "string"
},
"status": {
"description": "An indicator of the status of the filter query, e.g. OK for no blocked categories, BLOCKED where disclosure rules have been triggered",
"type": "string"
}
}
},
"downloads": {
"description": "The url to download the customised dataset. This will be blank until the jobs `state` has been marked completed and can only be updated if authorised\n",
"type": "object",
"properties": {
"csv": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the generated file",
"type": "string"
},
"private": {
"description": "The URL to a non public-accessible download",
"type": "string"
},
"public": {
"description": "The URL to a public-accessible download",
"type": "string"
},
"size": {
"description": "The size of the file in bytes",
"type": "string"
},
"skipped": {
"description": "A flag to indicate the file will not be generated due to size",
"type": "boolean"
}
}
},
"csvw": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the generated file",
"type": "string"
},
"private": {
"description": "The URL to a non public-accessible download",
"type": "string"
},
"public": {
"description": "The URL to a public-accessible download",
"type": "string"
},
"size": {
"description": "The size of the file in bytes",
"type": "string"
},
"skipped": {
"description": "A flag to indicate the file will not be generated due to size",
"type": "boolean"
}
}
},
"txt": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the generated file",
"type": "string"
},
"private": {
"description": "The URL to a non public-accessible download",
"type": "string"
},
"public": {
"description": "The URL to a public-accessible download",
"type": "string"
},
"size": {
"description": "The size of the file in bytes",
"type": "string"
},
"skipped": {
"description": "A flag to indicate the file will not be generated due to size",
"type": "boolean"
}
}
},
"xls": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the generated file",
"type": "string"
},
"private": {
"description": "The URL to a non public-accessible download",
"type": "string"
},
"public": {
"description": "The URL to a public-accessible download",
"type": "string"
},
"size": {
"description": "The size of the file in bytes",
"type": "string"
},
"skipped": {
"description": "A flag to indicate the file will not be generated due to size",
"type": "boolean"
}
}
}
}
},
"events": {
"type": "array",
"items": {
"description": "A description of an event which has happened to the resource",
"type": "object",
"properties": {
"name": {
"description": "The type of event which happened",
"type": "string",
"example": "cantabular-export-start"
},
"timestamp": {
"description": "The time of the event happened",
"type": "string",
"format": "string",
"example": "2016-07-17T08:38:25.316+0000"
}
}
}
},
"filter_id": {
"type": "string"
},
"id": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"links": {
"description": "A list of links related to this resource",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"description": "A URL to the filter",
"type": "string",
"example": "http://localhost:8080/filters/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": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc"
}
}
}
},
"readOnly": true
},
"population_type": {
"type": "string"
},
"published": {
"type": "boolean"
},
"state": {
"description": "This describes the status of the filter.",
"type": "string",
"enum": [
"completed",
"created"
]
},
"type": {
"type": "string"
}
}
}
]
}404: Filter output not found
Example value
null500: Failed to process the request due to an internal error
Example value
null