Update Filter

Update an existing filter.

Security Consideration

The query parameter of the request body takes a JSON-serialized query. Some query types (e.g. task queries) allow to specify EL expressions in their parameters and may therefore be abused for remote code execution. See the section on security considerations for custom code in the user guide for details.

Method

PUT /filter/{id}

Parameters

Request Body

A JSON object with the following properties:

Name Type Description
resourceType String The resource type of the filter, e.g., Task
name String The name of the filter.
owner String The user id of the owner of the filter.
query Object A JSON object which corresponds to the JSON body of a REST query. I.e., a filter which has the resourceType Task must contain a query which is a valid task query (see Task).
properties Object A JSON object containing various properties of the filter. The properties are user defined and no required properties exist. Properties can be used to save the priority or the description of a filter.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Filter was invalid. See Introduction for the error response format.
403 application/json The authenticated user is unauthorized to update this filter. See the Introduction for the error response format.
404 application/json Filter cannot be found. See the Introduction for the error response format.

Example

Request

PUT /filter/aFilterID

Request Body:

{
  "resourceType": "Task",
  "name": "My Tasks",
  "owner": "jonny1",
  "query": {
    "assignee": "jonny1"
  },
  "properties": {
    "color": "#99CCFF",
    "description": "Tasks assigned to me",
    "priority": -10
  }
}

Response

Status 204. No content.

On this Page: