/filters/{id}/dimensions/{name}/options/{option}
GET
Get a specified option from the options which will be used to filter the dimension
Responses
200: An option within a dimension was returned
Example value
{
"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
}
400: Filter or dimension name not found
Example value
null
404: Dimension option was not found
Example value
null
500: Failed to process the request due to an internal error
Example value
null
POST
Add an option to a filtered dimension
Parameters
Name | Type | Description |
---|---|---|
If-Match | header | Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check |
id | path | The unique filter ID for customising a dataset |
name | path | The name of a dimension |
option | path | The single option for a dimension |
Responses
201: Option was added
Example value
{
"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
}
400: Filter was not found
Example value
null
404: Dimension name was not found
Example value
null
409: #/responses/FilterConflict
Example value
null
422: Unprocessable entity - instance has been removed
Example value
null
500: Failed to process the request due to an internal error
Example value
null
DELETE
Remove a single option from a dimension
Parameters
Name | Type | Description |
---|---|---|
If-Match | header | Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check |
id | path | The unique filter ID for customising a dataset |
name | path | The name of a dimension |
option | path | The single option for a dimension |
Responses
204: Option was removed
Example value
null
400: This error code could be one or more of: * Filter was not found * Dimension name was not found
Example value
null
404: Dimension option was not found
Example value
null
409: #/responses/FilterConflict
Example value
null
500: Failed to process the request due to an internal error
Example value
null